From 0f1e2e460a671919b70ce9d247044362c87a12ce Mon Sep 17 00:00:00 2001 From: Hakan Ensari Date: Thu, 3 Oct 2024 17:45:13 +0200 Subject: [PATCH] Regenerate code --- ...warehousing_and_distribution_2024_05_09.rb | 39 +- lib/peddler/api/aplus_content_2020_11_01.rb | 76 ++-- .../api/application_management_2023_11_30.rb | 2 +- lib/peddler/api/catalog_items_2020_12_01.rb | 35 +- lib/peddler/api/catalog_items_2022_04_01.rb | 41 ++- lib/peddler/api/catalog_items_v0.rb | 55 ++- lib/peddler/api/data_kiosk_2023_11_15.rb | 39 +- lib/peddler/api/easy_ship_2022_03_23.rb | 56 +-- lib/peddler/api/fba_inbound_eligibility_v1.rb | 8 +- lib/peddler/api/fba_inventory_v1.rb | 39 +- lib/peddler/api/feeds_2021_06_30.rb | 41 ++- lib/peddler/api/finances_v0.rb | 52 ++- .../api/fulfillment_inbound_2024_03_20.rb | 334 +++++++++--------- lib/peddler/api/fulfillment_inbound_v0.rb | 119 +++---- .../api/fulfillment_outbound_2020_07_01.rb | 81 +++-- lib/peddler/api/listings_items_2020_09_01.rb | 60 ++-- lib/peddler/api/listings_items_2021_08_01.rb | 109 +++--- .../api/listings_restrictions_2021_08_01.rb | 17 +- lib/peddler/api/merchant_fulfillment_v0.rb | 20 +- lib/peddler/api/messaging_v1.rb | 98 ++--- lib/peddler/api/notifications_v1.rb | 38 +- lib/peddler/api/orders_v0.rb | 97 +++-- lib/peddler/api/product_fees_v0.rb | 52 ++- lib/peddler/api/product_pricing_2022_05_01.rb | 9 +- lib/peddler/api/product_pricing_v0.rb | 82 ++--- .../product_type_definitions_2020_09_01.rb | 34 +- lib/peddler/api/replenishment_2022_11_07.rb | 12 +- lib/peddler/api/reports_2021_06_30.rb | 53 ++- lib/peddler/api/sales_v1.rb | 21 +- lib/peddler/api/sellers_v1.rb | 4 +- lib/peddler/api/services_v1.rb | 155 ++++---- lib/peddler/api/shipment_invoicing_v0.rb | 18 +- lib/peddler/api/shipping_v1.rb | 40 +-- lib/peddler/api/shipping_v2.rb | 128 ++++--- lib/peddler/api/solicitations_v1.rb | 12 +- lib/peddler/api/supply_sources_2020_07_01.rb | 30 +- lib/peddler/api/tokens_2021_03_01.rb | 8 +- lib/peddler/api/uploads_2020_11_01.rb | 10 +- .../vendor_direct_fulfillment_inventory_v1.rb | 6 +- ...or_direct_fulfillment_orders_2021_12_28.rb | 27 +- .../vendor_direct_fulfillment_orders_v1.rb | 27 +- .../vendor_direct_fulfillment_payments_v1.rb | 4 +- ...ulfillment_sandbox_test_data_2021_10_28.rb | 8 +- ..._direct_fulfillment_shipping_2021_12_28.rb | 75 ++-- .../vendor_direct_fulfillment_shipping_v1.rb | 81 ++--- ...ect_fulfillment_transactions_2021_12_28.rb | 4 +- ...ndor_direct_fulfillment_transactions_v1.rb | 4 +- lib/peddler/api/vendor_invoices_v1.rb | 4 +- lib/peddler/api/vendor_orders_v1.rb | 64 ++-- lib/peddler/api/vendor_shipments_v1.rb | 90 ++--- .../api/vendor_transaction_status_v1.rb | 4 +- 51 files changed, 1229 insertions(+), 1293 deletions(-) diff --git a/lib/peddler/api/amazon_warehousing_and_distribution_2024_05_09.rb b/lib/peddler/api/amazon_warehousing_and_distribution_2024_05_09.rb index 0f21d5d4..991f0c87 100644 --- a/lib/peddler/api/amazon_warehousing_and_distribution_2024_05_09.rb +++ b/lib/peddler/api/amazon_warehousing_and_distribution_2024_05_09.rb @@ -18,10 +18,10 @@ class AmazonWarehousingAndDistribution20240509 < API # Retrieves an AWD inbound shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id ID for the shipment. A shipment contains the cases being inbounded. - # @param [String] sku_quantities If equal to `SHOW`, the response includes the shipment SKU quantity details. + # @param shipment_id [String] ID for the shipment. A shipment contains the cases being inbounded. + # @param sku_quantities [String] If equal to `SHOW`, the response includes the shipment SKU quantity details. # Defaults to `HIDE`, in which case the response does not contain SKU quantities - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_inbound_shipment(shipment_id, sku_quantities: nil, rate_limit: 2.0) path = "/awd/2024-05-09/inboundShipments/#{shipment_id}" @@ -36,21 +36,20 @@ def get_inbound_shipment(shipment_id, sku_quantities: nil, rate_limit: 2.0) # optional filters. # # @note This operation can make a static sandbox call. - # @param [String] sort_by Field to sort results by. By default, the response will be sorted by UPDATED_AT. - # @param [String] sort_order Sort the response in ASCENDING or DESCENDING order. By default, the response will be + # @param sort_by [String] Field to sort results by. By default, the response will be sorted by UPDATED_AT. + # @param sort_order [String] Sort the response in ASCENDING or DESCENDING order. By default, the response will be # sorted in DESCENDING order. - # @param [String] shipment_status Filter by inbound shipment status. - # @param [String] updated_after List the inbound shipments that were updated after a certain time (inclusive). The - # date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] updated_before List the inbound shipments that were updated before a certain time (inclusive). - # The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [Integer] max_results Maximum number of results to return. - # @param [String] next_token Token to retrieve the next set of paginated results. - # @param [Float] rate_limit Requests per second + # @param shipment_status [String] Filter by inbound shipment status. + # @param updated_after [String] List the inbound shipments that were updated after a certain time (inclusive). The + # date must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param updated_before [String] List the inbound shipments that were updated before a certain time (inclusive). + # The date must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param max_results [Integer] Maximum number of results to return. + # @param next_token [String] Token to retrieve the next set of paginated results. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_inbound_shipments(sort_by: nil, sort_order: nil, shipment_status: nil, updated_after: nil, updated_before: nil, max_results: 25, next_token: nil, rate_limit: 1.0) - path = "/awd/2024-05-09/inboundShipments" params = { "sortBy" => sort_by, @@ -68,13 +67,13 @@ def list_inbound_shipments(sort_by: nil, sort_order: nil, shipment_status: nil, # Lists AWD inventory associated with a merchant with the ability to apply optional filters. # # @note This operation can make a static sandbox call. - # @param [String] sku Filter by seller or merchant SKU for the item. - # @param [String] sort_order Sort the response in `ASCENDING` or `DESCENDING` order. - # @param [String] details Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` + # @param sku [String] Filter by seller or merchant SKU for the item. + # @param sort_order [String] Sort the response in `ASCENDING` or `DESCENDING` order. + # @param details [String] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` # which returns only inventory summary totals. - # @param [String] next_token Token to retrieve the next set of paginated results. - # @param [Integer] max_results Maximum number of results to return. - # @param [Float] rate_limit Requests per second + # @param next_token [String] Token to retrieve the next set of paginated results. + # @param max_results [Integer] Maximum number of results to return. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_inventory(sku: nil, sort_order: nil, details: nil, next_token: nil, max_results: 25, rate_limit: 2.0) path = "/awd/2024-05-09/inventory" diff --git a/lib/peddler/api/aplus_content_2020_11_01.rb b/lib/peddler/api/aplus_content_2020_11_01.rb index 4ca44ff6..18f8546c 100644 --- a/lib/peddler/api/aplus_content_2020_11_01.rb +++ b/lib/peddler/api/aplus_content_2020_11_01.rb @@ -21,13 +21,13 @@ class AplusContent20201101 < API # metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ # Content documents. # - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [String] page_token A page token from the nextPageToken response element returned by your previous call + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param page_token [String] A page token from the nextPageToken response element returned by your previous call # to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next # page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any # other parameter will cause the request to fail. When no nextPageToken value is returned there are no more # pages to return. A pageToken value is not usable across different operations. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def search_content_documents(marketplace_id, page_token: nil, rate_limit: 10.0) cannot_sandbox! @@ -43,9 +43,9 @@ def search_content_documents(marketplace_id, page_token: nil, rate_limit: 10.0) # Creates a new A+ Content document. # - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Hash] post_content_document_request The content document request details. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param post_content_document_request [Hash] The content document request details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_content_document(marketplace_id, post_content_document_request, rate_limit: 10.0) cannot_sandbox! @@ -61,12 +61,12 @@ def create_content_document(marketplace_id, post_content_document_request, rate_ # Returns an A+ Content document, if available. # - # @param [String] content_reference_key The unique reference key for the A+ Content document. A content reference + # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference # key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match # any A+ Content identifier. - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Array] included_data_set The set of A+ Content data types to include in the response. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param included_data_set [Array] The set of A+ Content data types to include in the response. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_content_document(content_reference_key, marketplace_id, included_data_set, rate_limit: 10.0) cannot_sandbox! @@ -82,12 +82,12 @@ def get_content_document(content_reference_key, marketplace_id, included_data_se # Updates an existing A+ Content document. # - # @param [String] content_reference_key The unique reference key for the A+ Content document. A content reference + # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference # key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match # any A+ Content identifier. - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Hash] post_content_document_request The content document request details. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param post_content_document_request [Hash] The content document request details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_content_document(content_reference_key, marketplace_id, post_content_document_request, rate_limit: 10.0) @@ -105,19 +105,19 @@ def update_content_document(content_reference_key, marketplace_id, post_content_ # Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the # asinSet parameter, the operation returns all ASINs related to the content document. # - # @param [String] content_reference_key The unique reference key for the A+ Content document. A content reference + # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference # key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match # any A+ Content identifier. - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Array] included_data_set The set of A+ Content data types to include in the response. If you do + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param included_data_set [Array] The set of A+ Content data types to include in the response. If you do # not include this parameter, the operation returns the related ASINs without metadata. - # @param [Array] asin_set The set of ASINs. - # @param [String] page_token A page token from the nextPageToken response element returned by your previous call + # @param asin_set [Array] The set of ASINs. + # @param page_token [String] A page token from the nextPageToken response element returned by your previous call # to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next # page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any # other parameter will cause the request to fail. When no nextPageToken value is returned there are no more # pages to return. A pageToken value is not usable across different operations. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_content_document_asin_relations(content_reference_key, marketplace_id, included_data_set: nil, asin_set: nil, page_token: nil, rate_limit: 10.0) @@ -138,12 +138,12 @@ def list_content_document_asin_relations(content_reference_key, marketplace_id, # depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content # document from that ASIN. # - # @param [String] content_reference_key The unique reference key for the A+ Content document. A content reference + # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference # key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match # any A+ content identifier. - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Hash] post_content_document_asin_relations_request The content document ASIN relations request details. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param post_content_document_asin_relations_request [Hash] The content document ASIN relations request details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def post_content_document_asin_relations(content_reference_key, marketplace_id, post_content_document_asin_relations_request, rate_limit: 10.0) @@ -160,10 +160,10 @@ def post_content_document_asin_relations(content_reference_key, marketplace_id, # Checks if the A+ Content document is valid for use on a set of ASINs. # - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Array] asin_set The set of ASINs. - # @param [Hash] post_content_document_request The content document request details. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param asin_set [Array] The set of ASINs. + # @param post_content_document_request [Hash] The content document request details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def validate_content_document_asin_relations(marketplace_id, post_content_document_request, asin_set: nil, rate_limit: 10.0) @@ -181,14 +181,14 @@ def validate_content_document_asin_relations(marketplace_id, post_content_docume # Searches for A+ Content publishing records, if available. # - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [String] asin The Amazon Standard Identification Number (ASIN). - # @param [String] page_token A page token from the nextPageToken response element returned by your previous call + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param asin [String] The Amazon Standard Identification Number (ASIN). + # @param page_token [String] A page token from the nextPageToken response element returned by your previous call # to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next # page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any # other parameter will cause the request to fail. When no nextPageToken value is returned there are no more # pages to return. A pageToken value is not usable across different operations. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def search_content_publish_records(marketplace_id, asin, page_token: nil, rate_limit: 10.0) cannot_sandbox! @@ -205,11 +205,11 @@ def search_content_publish_records(marketplace_id, asin, page_token: nil, rate_l # Submits an A+ Content document for review, approval, and publishing. # - # @param [String] content_reference_key The unique reference key for the A+ Content document. A content reference + # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference # key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match # any A+ content identifier. - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def post_content_document_approval_submission(content_reference_key, marketplace_id, rate_limit: 10.0) cannot_sandbox! @@ -225,11 +225,11 @@ def post_content_document_approval_submission(content_reference_key, marketplace # Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN # relations. # - # @param [String] content_reference_key The unique reference key for the A+ Content document. A content reference + # @param content_reference_key [String] The unique reference key for the A+ Content document. A content reference # key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match # any A+ content identifier. - # @param [String] marketplace_id The identifier for the marketplace where the A+ Content is published. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The identifier for the marketplace where the A+ Content is published. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def post_content_document_suspend_submission(content_reference_key, marketplace_id, rate_limit: 10.0) cannot_sandbox! diff --git a/lib/peddler/api/application_management_2023_11_30.rb b/lib/peddler/api/application_management_2023_11_30.rb index bfab389d..521b343e 100644 --- a/lib/peddler/api/application_management_2023_11_30.rb +++ b/lib/peddler/api/application_management_2023_11_30.rb @@ -21,7 +21,7 @@ class ApplicationManagement20231130 < API # client # secret](https://developer-docs.amazon.com/sp-api/v0/docs/application-management-api-v2023-11-30-use-case-guide#tutorial-rotate-your-applications-client-secret). # - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def rotate_application_client_secret(rate_limit: 0.0167) cannot_sandbox! diff --git a/lib/peddler/api/catalog_items_2020_12_01.rb b/lib/peddler/api/catalog_items_2020_12_01.rb index c0ed5220..0b7e12b8 100644 --- a/lib/peddler/api/catalog_items_2020_12_01.rb +++ b/lib/peddler/api/catalog_items_2020_12_01.rb @@ -13,31 +13,30 @@ class API # Selling Partner API for Catalog Items # # The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon - # catalog. For more information, see the [Catalog Items API Use Case - # Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2020-12-01-use-case-guide). + # catalog. For more information, see the {Catalog Items API Use Case Guide + # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2020-12-01-use-case-guide}. class CatalogItems20201201 < API # Search for and return a list of Amazon catalog items and associated information. # # @note This operation can make a static sandbox call. - # @param [Array] keywords A comma-delimited list of words or item identifiers to search the Amazon catalog + # @param keywords [Array] A comma-delimited list of words or item identifiers to search the Amazon catalog # for. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # summaries. - # @param [Array] brand_names A comma-delimited list of brand names to limit the search to. - # @param [Array] classification_ids A comma-delimited list of classification identifiers to limit the + # @param brand_names [Array] A comma-delimited list of brand names to limit the search to. + # @param classification_ids [Array] A comma-delimited list of classification identifiers to limit the # search to. - # @param [Integer] page_size Number of results to be returned per page. - # @param [String] page_token A token to fetch a certain page when there are multiple pages worth of results. - # @param [String] keywords_locale The language the keywords are provided in. Defaults to the primary locale of the + # @param page_size [Integer] Number of results to be returned per page. + # @param page_token [String] A token to fetch a certain page when there are multiple pages worth of results. + # @param keywords_locale [String] The language the keywords are provided in. Defaults to the primary locale of the # marketplace. - # @param [String] locale Locale for retrieving localized summaries. Defaults to the primary locale of the + # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the # marketplace. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def search_catalog_items(keywords, marketplace_ids, included_data: "summaries", brand_names: nil, classification_ids: nil, page_size: 10, page_token: nil, keywords_locale: nil, locale: nil, rate_limit: 2.0) - path = "/catalog/2020-12-01/items" params = { "keywords" => keywords, @@ -57,14 +56,14 @@ def search_catalog_items(keywords, marketplace_ids, included_data: "summaries", # Retrieves details for an item in the Amazon catalog. # # @note This operation can make a static sandbox call. - # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers. Data sets in + # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers. Data sets in # the response contain data only for the specified marketplaces. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # summaries. - # @param [String] locale Locale for retrieving localized summaries. Defaults to the primary locale of the + # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the # marketplace. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_catalog_item(asin, marketplace_ids, included_data: "summaries", locale: nil, rate_limit: 2.0) path = "/catalog/2020-12-01/items/#{asin}" diff --git a/lib/peddler/api/catalog_items_2022_04_01.rb b/lib/peddler/api/catalog_items_2022_04_01.rb index 3eb3b9b5..11fce27c 100644 --- a/lib/peddler/api/catalog_items_2022_04_01.rb +++ b/lib/peddler/api/catalog_items_2022_04_01.rb @@ -13,40 +13,39 @@ class API # Selling Partner API for Catalog Items # # The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon - # catalog. For more information, refer to the [Catalog Items API Use Case - # Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide). + # catalog. For more information, refer to the {Catalog Items API Use Case Guide + # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide}. class CatalogItems20220401 < API # Search for and return a list of Amazon catalog items and associated information either by identifier or by # keywords. # # @note This operation can make a static sandbox call. - # @param [Array] identifiers A comma-delimited list of product identifiers to search the Amazon catalog + # @param identifiers [Array] A comma-delimited list of product identifiers to search the Amazon catalog # for. **Note:** Cannot be used with `keywords`. - # @param [String] identifiers_type Type of product identifiers to search the Amazon catalog for. **Note:** + # @param identifiers_type [String] Type of product identifiers to search the Amazon catalog for. **Note:** # Required when `identifiers` are provided. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # `summaries`. - # @param [String] locale Locale for retrieving localized summaries. Defaults to the primary locale of the + # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the # marketplace. - # @param [String] seller_id A selling partner identifier, such as a seller account or vendor code. **Note:** + # @param seller_id [String] A selling partner identifier, such as a seller account or vendor code. **Note:** # Required when `identifiersType` is `SKU`. - # @param [Array] keywords A comma-delimited list of words to search the Amazon catalog for. **Note:** + # @param keywords [Array] A comma-delimited list of words to search the Amazon catalog for. **Note:** # Cannot be used with `identifiers`. - # @param [Array] brand_names A comma-delimited list of brand names to limit the search for + # @param brand_names [Array] A comma-delimited list of brand names to limit the search for # `keywords`-based queries. **Note:** Cannot be used with `identifiers`. - # @param [Array] classification_ids A comma-delimited list of classification identifiers to limit the + # @param classification_ids [Array] A comma-delimited list of classification identifiers to limit the # search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. - # @param [Integer] page_size Number of results to be returned per page. - # @param [String] page_token A token to fetch a certain page when there are multiple pages worth of results. - # @param [String] keywords_locale The language of the keywords provided for `keywords`-based queries. Defaults to + # @param page_size [Integer] Number of results to be returned per page. + # @param page_token [String] A token to fetch a certain page when there are multiple pages worth of results. + # @param keywords_locale [String] The language of the keywords provided for `keywords`-based queries. Defaults to # the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def search_catalog_items(marketplace_ids, identifiers: nil, identifiers_type: nil, included_data: ["summaries"], locale: nil, seller_id: nil, keywords: nil, brand_names: nil, classification_ids: nil, page_size: 10, page_token: nil, keywords_locale: nil, rate_limit: 2.0) - path = "/catalog/2022-04-01/items" params = { "identifiers" => identifiers, @@ -69,14 +68,14 @@ def search_catalog_items(marketplace_ids, identifiers: nil, identifiers_type: ni # Retrieves details for an item in the Amazon catalog. # # @note This operation can make a static sandbox call. - # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers. Data sets in + # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers. Data sets in # the response contain data only for the specified marketplaces. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # `summaries`. - # @param [String] locale Locale for retrieving localized summaries. Defaults to the primary locale of the + # @param locale [String] Locale for retrieving localized summaries. Defaults to the primary locale of the # marketplace. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_catalog_item(asin, marketplace_ids, included_data: ["summaries"], locale: nil, rate_limit: 2.0) path = "/catalog/2022-04-01/items/#{asin}" diff --git a/lib/peddler/api/catalog_items_v0.rb b/lib/peddler/api/catalog_items_v0.rb index 9cb8b29a..569e0b5d 100644 --- a/lib/peddler/api/catalog_items_v0.rb +++ b/lib/peddler/api/catalog_items_v0.rb @@ -17,33 +17,32 @@ class API class CatalogItemsV0 < API # Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling # Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of - # the [Selling Partner API for Catalog Items - # v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). - # Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation - # to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not - # being deprecated and you can continue to make calls to it. + # the {Selling Partner API for Catalog Items v2022-04-01 + # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference}. Integrations that rely + # on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service + # disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated + # and you can continue to make calls to it. # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which items are returned. - # @param [String] query Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. - # @param [String] query_context_id An identifier for the context within which the given search will be performed. + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which items are returned. + # @param query [String] Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. + # @param query_context_id [String] An identifier for the context within which the given search will be performed. # A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, # the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter # specifies such a subset. If it is omitted, the search will be performed using the default context for the # marketplace, which will typically contain the largest set of items. - # @param [String] seller_sku Used to identify an item in the given marketplace. SellerSKU is qualified by the + # @param seller_sku [String] Used to identify an item in the given marketplace. SellerSKU is qualified by the # seller's SellerId, which is included with every operation that you submit. - # @param [String] upc A 12-digit bar code used for retail packaging. - # @param [String] ean A European article number that uniquely identifies the catalog item, manufacturer, and its + # @param upc [String] A 12-digit bar code used for retail packaging. + # @param ean [String] A European article number that uniquely identifies the catalog item, manufacturer, and its # attributes. - # @param [String] isbn The unique commercial book identifier used to identify books internationally. - # @param [String] jan A Japanese article number that uniquely identifies the product, manufacturer, and its + # @param isbn [String] The unique commercial book identifier used to identify books internationally. + # @param jan [String] A Japanese article number that uniquely identifies the product, manufacturer, and its # attributes. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_catalog_items(marketplace_id, query: nil, query_context_id: nil, seller_sku: nil, upc: nil, ean: nil, isbn: nil, jan: nil, rate_limit: nil) - path = "/catalog/v0/items" params = { "MarketplaceId" => marketplace_id, @@ -60,17 +59,17 @@ def list_catalog_items(marketplace_id, query: nil, query_context_id: nil, seller end # Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner - # API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for - # Catalog Items - # v2022-04-01](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference). - # Integrations that rely on this operation should migrate to the latest version to avoid service disruption. - # _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can - # continue to make calls to it. + # API for Catalog Items v0. This operation is available in the latest version of the {Selling Partner API for + # Catalog Items v2022-04-01 + # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference}. Integrations that rely + # on this operation should migrate to the latest version to avoid service disruption. _Note:_ The + # [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to + # make calls to it. # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for the item. - # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for the item. + # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_catalog_item(marketplace_id, asin, rate_limit: nil) path = "/catalog/v0/items/#{asin}" @@ -84,11 +83,11 @@ def get_catalog_item(marketplace_id, asin, rate_limit: nil) # Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for the item. - # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item. - # @param [String] seller_sku Used to identify items in the given marketplace. SellerSKU is qualified by the + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for the item. + # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item. + # @param seller_sku [String] Used to identify items in the given marketplace. SellerSKU is qualified by the # seller's SellerId, which is included with every operation that you submit. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_catalog_categories(marketplace_id, asin: nil, seller_sku: nil, rate_limit: 1.0) path = "/catalog/v0/categories" diff --git a/lib/peddler/api/data_kiosk_2023_11_15.rb b/lib/peddler/api/data_kiosk_2023_11_15.rb index d339b338..daacbcd1 100644 --- a/lib/peddler/api/data_kiosk_2023_11_15.rb +++ b/lib/peddler/api/data_kiosk_2023_11_15.rb @@ -19,22 +19,21 @@ class DataKiosk20231115 < API # details about query retention. # # @note This operation can make a static sandbox call. - # @param [Array] processing_statuses A list of processing statuses used to filter queries. - # @param [Integer] page_size The maximum number of queries to return in a single call. - # @param [String] created_since The earliest query creation date and time for queries to include in the response, + # @param processing_statuses [Array] A list of processing statuses used to filter queries. + # @param page_size [Integer] The maximum number of queries to return in a single call. + # @param created_since [String] The earliest query creation date and time for queries to include in the response, # in ISO 8601 date time format. The default is 90 days ago. - # @param [String] created_until The latest query creation date and time for queries to include in the response, in + # @param created_until [String] The latest query creation date and time for queries to include in the response, in # ISO 8601 date time format. The default is the time of the `getQueries` request. - # @param [String] pagination_token A token to fetch a certain page of results when there are multiple pages of + # @param pagination_token [String] A token to fetch a certain page of results when there are multiple pages of # results available. The value of this token is fetched from the `pagination.nextToken` field returned in the # `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided # with the request that generated this token, with the exception of `pageSize` which can be modified between # calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_queries(processing_statuses: nil, page_size: 10, created_since: nil, created_until: nil, pagination_token: nil, rate_limit: 0.0222) - path = "/dataKiosk/2023-11-15/queries" params = { "processingStatuses" => processing_statuses, @@ -47,15 +46,15 @@ def get_queries(processing_statuses: nil, page_size: 10, created_since: nil, cre meter(rate_limit).get(path, params:) end - # Creates a Data Kiosk query request. - # @note The retention of a query varies based on the fields requested. Each field within a schema is annotated - # with a `@resultRetention` directive that defines how long a query containing that field will be retained. When - # a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The - # retention of a query's resulting documents always matches the retention of the query. + # Creates a Data Kiosk query request. **Note:** The retention of a query varies based on the fields requested. + # Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query + # containing that field will be retained. When a query contains multiple fields with different retentions, the + # shortest (minimum) retention is applied. The retention of a query's resulting documents always matches the + # retention of the query. # # @note This operation can make a static sandbox call. - # @param [Hash] body The body of the request. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The body of the request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_query(body, rate_limit: 0.0167) path = "/dataKiosk/2023-11-15/queries" @@ -69,9 +68,9 @@ def create_query(body, rate_limit: 0.0167) # operations. # # @note This operation can make a static sandbox call. - # @param [String] query_id The identifier for the query. This identifier is unique only in combination with a + # @param query_id [String] The identifier for the query. This identifier is unique only in combination with a # selling partner account ID. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_query(query_id, rate_limit: 0.0222) path = "/dataKiosk/2023-11-15/queries/#{query_id}" @@ -83,8 +82,8 @@ def cancel_query(query_id, rate_limit: 0.0222) # details about query retention. # # @note This operation can make a static sandbox call. - # @param [String] query_id The query identifier. - # @param [Float] rate_limit Requests per second + # @param query_id [String] The query identifier. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_query(query_id, rate_limit: 2.0) path = "/dataKiosk/2023-11-15/queries/#{query_id}" @@ -96,8 +95,8 @@ def get_query(query_id, rate_limit: 2.0) # operation for details about document retention. # # @note This operation can make a static sandbox call. - # @param [String] document_id The identifier for the Data Kiosk document. - # @param [Float] rate_limit Requests per second + # @param document_id [String] The identifier for the Data Kiosk document. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_document(document_id, rate_limit: 0.0167) path = "/dataKiosk/2023-11-15/documents/#{document_id}" diff --git a/lib/peddler/api/easy_ship_2022_03_23.rb b/lib/peddler/api/easy_ship_2022_03_23.rb index 726957d4..fc5e9456 100644 --- a/lib/peddler/api/easy_ship_2022_03_23.rb +++ b/lib/peddler/api/easy_ship_2022_03_23.rb @@ -15,21 +15,21 @@ class API # The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy # Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for # delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the - # [Marketplace Support - # Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) + # {Marketplace Support Table + # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table} # for the differences in Easy Ship operations by marketplace. class EasyShip20220323 < API # Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions # that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace - # support. See **Get Time Slots** in the [Marketplace Support - # Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). + # support. See **Get Time Slots** in the {Marketplace Support Table + # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}. # This operation can return time slots that have either pickup or drop-off handover methods - see **Supported - # Handover Methods** in the [Marketplace Support - # Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). + # Handover Methods** in the {Marketplace Support Table + # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}. # # @note This operation can make a static sandbox call. - # @param [Hash] list_handover_slots_request The request schema for the `listHandoverSlots` operation. - # @param [Float] rate_limit Requests per second + # @param list_handover_slots_request [Hash] The request schema for the `listHandoverSlots` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_handover_slots(list_handover_slots_request: nil, rate_limit: 1.0) path = "/easyShip/2022-03-23/timeSlot" @@ -42,10 +42,10 @@ def list_handover_slots(list_handover_slots_request: nil, rate_limit: 1.0) # and item information, and status. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon-defined order identifier. Identifies the order that the seller wants + # @param amazon_order_id [String] An Amazon-defined order identifier. Identifies the order that the seller wants # to deliver using Amazon Easy Ship. - # @param [String] marketplace_id An identifier for the marketplace in which the seller is selling. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] An identifier for the marketplace in which the seller is selling. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_scheduled_package(amazon_order_id, marketplace_id, rate_limit: 1.0) path = "/easyShip/2022-03-23/package" @@ -60,18 +60,18 @@ def get_scheduled_package(amazon_order_id, marketplace_id, rate_limit: 1.0) # Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * # Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship # order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a - # warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, - # shipping label, and warranty - # documents](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide). * Shows the - # status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and - # examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and - # **Warranty** columns in the [Marketplace Support - # Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) + # warranty document if you specify a `SerialNumber` value. To get these documents, see {How to get invoice, + # shipping label, and warranty documents + # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide}. * Shows the status of + # Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the + # `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and + # **Warranty** columns in the {Marketplace Support Table + # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table} # to see which documents are supported in each marketplace. # # @note This operation can make a static sandbox call. - # @param [Hash] create_scheduled_package_request The request schema for the `createScheduledPackage` operation. - # @param [Float] rate_limit Requests per second + # @param create_scheduled_package_request [Hash] The request schema for the `createScheduledPackage` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_scheduled_package(create_scheduled_package_request, rate_limit: 1.0) path = "/easyShip/2022-03-23/package" @@ -82,13 +82,13 @@ def create_scheduled_package(create_scheduled_package_request, rate_limit: 1.0) # Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get # the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another - # `patch` call. See the **Update Package** column in the [Marketplace Support - # Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) + # `patch` call. See the **Update Package** column in the {Marketplace Support Table + # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table} # to see which marketplaces this operation is supported in. # # @note This operation can make a static sandbox call. - # @param [Hash] update_scheduled_packages_request The request schema for the `updateScheduledPackages` operation. - # @param [Float] rate_limit Requests per second + # @param update_scheduled_packages_request [Hash] The request schema for the `updateScheduledPackages` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit: 1.0) path = "/easyShip/2022-03-23/package" @@ -99,8 +99,8 @@ def update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit # This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the # associated shipping labels, along with other compliance documents according to the marketplace (refer to the - # [marketplace document support - # table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). + # {marketplace document support table + # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}). # Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a # preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective # packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will @@ -113,9 +113,9 @@ def update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit # sellers can take action. The table below displays the supported request and burst maximum rates: # # @note This operation can make a static sandbox call. - # @param [Hash] create_scheduled_packages_request The request schema for the `createScheduledPackageBulk` + # @param create_scheduled_packages_request [Hash] The request schema for the `createScheduledPackageBulk` # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_scheduled_package_bulk(create_scheduled_packages_request, rate_limit: 1.0) path = "/easyShip/2022-03-23/packages/bulk" diff --git a/lib/peddler/api/fba_inbound_eligibility_v1.rb b/lib/peddler/api/fba_inbound_eligibility_v1.rb index 068caca4..bb04885d 100644 --- a/lib/peddler/api/fba_inbound_eligibility_v1.rb +++ b/lib/peddler/api/fba_inbound_eligibility_v1.rb @@ -23,11 +23,11 @@ class FBAInboundEligibilityV1 < API # you want to determine the item's eligibility. # # @note This operation can make a static sandbox call. - # @param [Array] marketplace_ids The identifier for the marketplace in which you want to determine + # @param marketplace_ids [Array] The identifier for the marketplace in which you want to determine # eligibility. Required only when program=INBOUND. - # @param [String] asin The ASIN of the item for which you want an eligibility preview. - # @param [String] program The program that you want to check eligibility against. - # @param [Float] rate_limit Requests per second + # @param asin [String] The ASIN of the item for which you want an eligibility preview. + # @param program [String] The program that you want to check eligibility against. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_item_eligibility_preview(asin, program, marketplace_ids: nil, rate_limit: 1.0) path = "/fba/inbound/v1/eligibility/itemPreview" diff --git a/lib/peddler/api/fba_inventory_v1.rb b/lib/peddler/api/fba_inventory_v1.rb index f50c3820..006d0696 100644 --- a/lib/peddler/api/fba_inventory_v1.rb +++ b/lib/peddler/api/fba_inventory_v1.rb @@ -28,26 +28,25 @@ class FBAInventoryV1 < API # SKUs when encoding URLs, refer to URL Encoding. # # @note This operation can make a dynamic sandbox call. - # @param [Boolean] details true to return inventory summaries with additional summarized inventory details and + # @param details [Boolean] true to return inventory summaries with additional summarized inventory details and # quantities. Otherwise, returns inventory summaries only (default value). - # @param [String] granularity_type The granularity type for the inventory aggregation level. - # @param [String] granularity_id The granularity ID for the inventory aggregation level. - # @param [String] start_date_time A start date and time in ISO8601 format. If specified, all inventory summaries + # @param granularity_type [String] The granularity type for the inventory aggregation level. + # @param granularity_id [String] The granularity ID for the inventory aggregation level. + # @param start_date_time [String] A start date and time in ISO8601 format. If specified, all inventory summaries # that have changed since then are returned. You must specify a date and time that is no earlier than 18 months # prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, # inboundShippedQuantity and inboundReceivingQuantity are not detected. - # @param [Array] seller_skus A list of seller SKUs for which to return inventory summaries. You may + # @param seller_skus [Array] A list of seller SKUs for which to return inventory summaries. You may # specify up to 50 SKUs. - # @param [String] seller_sku A single seller SKU used for querying the specified seller SKU inventory summaries. - # @param [String] next_token String token returned in the response of your previous request. The string token will + # @param seller_sku [String] A single seller SKU used for querying the specified seller SKU inventory summaries. + # @param next_token [String] String token returned in the response of your previous request. The string token will # expire 30 seconds after being created. - # @param [Array] marketplace_ids The marketplace ID for the marketplace for which to return inventory + # @param marketplace_ids [Array] The marketplace ID for the marketplace for which to return inventory # summaries. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response - def get_inventory_summaries(granularity_type, granularity_id, marketplace_ids, details: nil, - start_date_time: nil, seller_skus: nil, seller_sku: nil, next_token: nil, rate_limit: 2.0) - + def get_inventory_summaries(granularity_type, granularity_id, marketplace_ids, details: nil, start_date_time: nil, + seller_skus: nil, seller_sku: nil, next_token: nil, rate_limit: 2.0) path = "/fba/inventory/v1/summaries" params = { "details" => details, @@ -68,8 +67,8 @@ def get_inventory_summaries(granularity_type, granularity_id, marketplace_ids, d # sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] create_inventory_item_request_body CreateInventoryItem Request Body Parameter. - # @param [Float] rate_limit Requests per second + # @param create_inventory_item_request_body [Hash] CreateInventoryItem Request Body Parameter. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_inventory_item(create_inventory_item_request_body, rate_limit: nil) must_sandbox! @@ -85,9 +84,9 @@ def create_inventory_item(create_inventory_item_request_body, rate_limit: nil) # sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information. # # @note This operation can make a dynamic sandbox call. - # @param [String] seller_sku A single seller SKU used for querying the specified seller SKU inventory summaries. - # @param [String] marketplace_id The marketplace ID for the marketplace for which the sellerSku is to be deleted. - # @param [Float] rate_limit Requests per second + # @param seller_sku [String] A single seller SKU used for querying the specified seller SKU inventory summaries. + # @param marketplace_id [String] The marketplace ID for the marketplace for which the sellerSku is to be deleted. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def delete_inventory_item(seller_sku, marketplace_id, rate_limit: nil) must_sandbox! @@ -106,9 +105,9 @@ def delete_inventory_item(seller_sku, marketplace_id, rate_limit: nil) # information. # # @note This operation can make a dynamic sandbox call. - # @param [String] x_amzn_idempotency_token A unique token/requestId provided with each call to ensure idempotency. - # @param [Hash] add_inventory_request_body List of items to add to Sandbox inventory. - # @param [Float] rate_limit Requests per second + # @param x_amzn_idempotency_token [String] A unique token/requestId provided with each call to ensure idempotency. + # @param add_inventory_request_body [Hash] List of items to add to Sandbox inventory. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def add_inventory(x_amzn_idempotency_token, add_inventory_request_body, rate_limit: nil) must_sandbox! diff --git a/lib/peddler/api/feeds_2021_06_30.rb b/lib/peddler/api/feeds_2021_06_30.rb index aea07f9c..0935c392 100644 --- a/lib/peddler/api/feeds_2021_06_30.rb +++ b/lib/peddler/api/feeds_2021_06_30.rb @@ -17,26 +17,25 @@ class Feeds20210630 < API # Returns feed details for the feeds that match the filters that you specify. # # @note This operation can make a static sandbox call. - # @param [Array] feed_types A list of feed types used to filter feeds. When feedTypes is provided, the + # @param feed_types [Array] 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. - # @param [Array] marketplace_ids A list of marketplace identifiers used to filter feeds. The feeds + # @param marketplace_ids [Array] A list of marketplace identifiers used to filter feeds. The feeds # returned will match at least one of the marketplaces that you specify. - # @param [Integer] page_size The maximum number of feeds to return in a single call. - # @param [Array] processing_statuses A list of processing statuses used to filter feeds. - # @param [String] created_since The earliest feed creation date and time for feeds included in the response, in + # @param page_size [Integer] The maximum number of feeds to return in a single call. + # @param processing_statuses [Array] A list of processing statuses used to filter feeds. + # @param created_since [String] 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. - # @param [String] created_until The latest feed creation date and time for feeds included in the response, in ISO + # @param created_until [String] The latest feed creation date and time for feeds included in the response, in ISO # 8601 format. The default is now. - # @param [String] next_token A string token returned in the response to your previous request. nextToken is + # @param next_token [String] 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. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response - 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) - + 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" => feed_types, @@ -54,8 +53,8 @@ def get_feeds(feed_types: nil, marketplace_ids: nil, page_size: 10, processing_s # Creates a feed. Upload the contents of the feed document before calling this operation. # # @note This operation can make a static sandbox call. - # @param [Hash] body Information required to create the feed. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Information required to create the feed. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_feed(body, rate_limit: 0.0083) path = "/feeds/2021-06-30/feeds" @@ -69,9 +68,9 @@ def create_feed(body, rate_limit: 0.0083) # [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations. # # @note This operation can make a static sandbox call. - # @param [String] feed_id The identifier for the feed. This identifier is unique only in combination with a seller + # @param feed_id [String] The identifier for the feed. This identifier is unique only in combination with a seller # ID. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_feed(feed_id, rate_limit: 2.0) path = "/feeds/2021-06-30/feeds/#{feed_id}" @@ -82,9 +81,9 @@ def cancel_feed(feed_id, rate_limit: 2.0) # Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify. # # @note This operation can make a static sandbox call. - # @param [String] feed_id The identifier for the feed. This identifier is unique only in combination with a seller + # @param feed_id [String] The identifier for the feed. This identifier is unique only in combination with a seller # ID. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_feed(feed_id, rate_limit: 2.0) path = "/feeds/2021-06-30/feeds/#{feed_id}" @@ -98,8 +97,8 @@ def get_feed(feed_id, rate_limit: 2.0) # operation. # # @note This operation can make a static sandbox call. - # @param [Hash] body Specifies the content type for the createFeedDocument operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Specifies the content type for the createFeedDocument operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_feed_document(body, rate_limit: 0.5) path = "/feeds/2021-06-30/documents" @@ -110,8 +109,8 @@ def create_feed_document(body, rate_limit: 0.5) # Returns the information required for retrieving a feed document's contents. # # @note This operation can make a static sandbox call. - # @param [String] feed_document_id The identifier of the feed document. - # @param [Float] rate_limit Requests per second + # @param feed_document_id [String] The identifier of the feed document. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_feed_document(feed_document_id, rate_limit: 0.0222) path = "/feeds/2021-06-30/documents/#{feed_document_id}" diff --git a/lib/peddler/api/finances_v0.rb b/lib/peddler/api/finances_v0.rb index 387b0561..2a23f017 100644 --- a/lib/peddler/api/finances_v0.rb +++ b/lib/peddler/api/finances_v0.rb @@ -20,23 +20,22 @@ class FinancesV0 < API # financial events. # # @note This operation can make a static sandbox call. - # @param [Integer] max_results_per_page The maximum number of results to return per page. If the response exceeds + # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds # the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - # @param [String] financial_event_group_started_before A date used for selecting financial event groups that + # @param financial_event_group_started_before [String] A date used for selecting financial event groups that # opened before (but not at) a specified date and time, in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than # FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If # FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no # financial event groups are returned. - # @param [String] financial_event_group_started_after A date used for selecting financial event groups that opened + # @param financial_event_group_started_after [String] A date used for selecting financial event groups that opened # after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) # format. The date-time must be no later than two minutes before the request was submitted. - # @param [String] next_token A string token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param next_token [String] A string token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_financial_event_groups(max_results_per_page: 100, financial_event_group_started_before: nil, financial_event_group_started_after: nil, next_token: nil, rate_limit: 0.5) - path = "/finances/v0/financialEventGroups" params = { "MaxResultsPerPage" => max_results_per_page, @@ -49,29 +48,27 @@ def list_financial_event_groups(max_results_per_page: 100, financial_event_group end # Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to - # appear in your financial events. - # @note This operation will only retrieve group's data for the past two years. If a request is submitted for data - # spanning more than two years, an empty response is returned. + # appear in your financial events. **Note:** This operation will only retrieve group's data for the past two + # years. If a request is submitted for data spanning more than two years, an empty response is returned. # # @note This operation can make a static sandbox call. - # @param [Integer] max_results_per_page The maximum number of results to return per page. If the response exceeds + # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds # the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - # @param [String] posted_after A date used for selecting financial events posted after (or at) a specified time. + # @param posted_after [String] A date used for selecting financial events posted after (or at) a specified time. # The date-time **must** be more than two minutes before the time of the request, in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. - # @param [String] posted_before A date used for selecting financial events posted before (but not at) a specified + # @param posted_before [String] A date used for selecting financial events posted before (but not at) a specified # time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was # submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If # `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must # specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two # minutes. - # @param [String] event_group_id The identifier of the financial event group to which the events belong. - # @param [String] next_token A string token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param event_group_id [String] The identifier of the financial event group to which the events belong. + # @param next_token [String] A string token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_financial_events_by_group_id(event_group_id, max_results_per_page: 100, posted_after: nil, posted_before: nil, next_token: nil, rate_limit: 0.5) - path = "/finances/v0/financialEventGroups/#{event_group_id}/financialEvents" params = { "MaxResultsPerPage" => max_results_per_page, @@ -87,11 +84,11 @@ def list_financial_events_by_group_id(event_group_id, max_results_per_page: 100, # financial events. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [Integer] max_results_per_page The maximum number of results to return per page. If the response exceeds + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds # the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - # @param [String] next_token A string token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param next_token [String] A string token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_financial_events_by_order_id(order_id, max_results_per_page: 100, next_token: nil, rate_limit: 0.5) path = "/finances/v0/orders/#{order_id}/financialEvents" @@ -104,26 +101,25 @@ def list_financial_events_by_order_id(order_id, max_results_per_page: 100, next_ end # Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your - # financial events. - # @note in `ListFinancialEvents`, deferred events don't show up in responses until in they are released. + # financial events. **Note:** in `ListFinancialEvents`, deferred events don't show up in responses until in they + # are released. # # @note This operation can make a static sandbox call. - # @param [Integer] max_results_per_page The maximum number of results to return per page. If the response exceeds + # @param max_results_per_page [Integer] The maximum number of results to return per page. If the response exceeds # the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - # @param [String] posted_after A date used for selecting financial events posted after (or at) a specified time. + # @param posted_after [String] A date used for selecting financial events posted after (or at) a specified time. # The date-time must be no later than two minutes before the request was submitted, in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. - # @param [String] posted_before A date used for selecting financial events posted before (but not at) a specified + # @param posted_before [String] A date used for selecting financial events posted before (but not at) a specified # time. The date-time must be later than PostedAfter and no later than two minutes before the request was # submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If # PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify # the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. - # @param [String] next_token A string token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param next_token [String] A string token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_financial_events(max_results_per_page: 100, posted_after: nil, posted_before: nil, next_token: nil, rate_limit: 0.5) - path = "/finances/v0/financialEvents" params = { "MaxResultsPerPage" => max_results_per_page, diff --git a/lib/peddler/api/fulfillment_inbound_2024_03_20.rb b/lib/peddler/api/fulfillment_inbound_2024_03_20.rb index 8131ed25..6d1265f6 100644 --- a/lib/peddler/api/fulfillment_inbound_2024_03_20.rb +++ b/lib/peddler/api/fulfillment_inbound_2024_03_20.rb @@ -19,18 +19,17 @@ class FulfillmentInbound20240320 < API # Provides a list of inbound plans with minimal information. # # @note This operation can make a static sandbox call. - # @param [Integer] page_size The number of inbound plans to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param page_size [Integer] The number of inbound plans to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [String] status The status of an inbound plan. - # @param [String] sort_by Sort by field. - # @param [String] sort_order The sort order. - # @param [Float] rate_limit Requests per second + # @param status [String] The status of an inbound plan. + # @param sort_by [String] Sort by field. + # @param sort_order [String] The sort order. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_by: nil, sort_order: nil, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans" params = { "pageSize" => page_size, @@ -47,8 +46,8 @@ def list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_b # fufillment network. # # @note This operation can make a static sandbox call. - # @param [Hash] body The body of the request to `createInboundPlan`. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The body of the request to `createInboundPlan`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_inbound_plan(body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans" @@ -59,8 +58,8 @@ def create_inbound_plan(body, rate_limit: 2.0) # Fetches the top level information about an inbound plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_inbound_plan(inbound_plan_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}" @@ -71,12 +70,12 @@ def get_inbound_plan(inbound_plan_id, rate_limit: 2.0) # Provides a paginated list of box packages in an inbound plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Integer] page_size The number of boxes to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param page_size [Integer] The number of boxes to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/boxes" @@ -93,8 +92,8 @@ def list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: ni # (LTL) carrier shipments. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_inbound_plan(inbound_plan_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/cancellation" @@ -105,12 +104,12 @@ def cancel_inbound_plan(inbound_plan_id, rate_limit: 2.0) # Provides a paginated list of item packages in an inbound plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Integer] page_size The number of items to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param page_size [Integer] The number of items to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/items" @@ -125,9 +124,9 @@ def list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: ni # Updates the name of an existing inbound plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Hash] body The body of the request to `updateInboundPlanName`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param body [Hash] The body of the request to `updateInboundPlanName`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_inbound_plan_name(inbound_plan_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/name" @@ -140,17 +139,16 @@ def update_inbound_plan_name(inbound_plan_id, body, rate_limit: 2.0) # determines shipment splits. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] packing_group_id Identifier of a packing group. - # @param [Integer] page_size The number of packing group boxes to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param packing_group_id [String] Identifier of a packing group. + # @param page_size [Integer] The number of packing group boxes to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingGroups/#{packing_group_id}/boxes" params = { "pageSize" => page_size, @@ -164,17 +162,16 @@ def list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, p # operation before packing group items can be listed. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] packing_group_id Identifier of a packing group. - # @param [Integer] page_size The number of packing group items to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param packing_group_id [String] Identifier of a packing group. + # @param page_size [Integer] The number of packing group items to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingGroups/#{packing_group_id}/items" params = { "pageSize" => page_size, @@ -188,9 +185,9 @@ def list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, p # the box level information required for planning and transportation estimates. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Hash] body The body of the request to `setPackingInformation`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param body [Hash] The body of the request to `setPackingInformation`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def set_packing_information(inbound_plan_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingInformation" @@ -202,12 +199,12 @@ def set_packing_information(inbound_plan_id, body, rate_limit: 2.0) # corresponding operation before becoming available. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Integer] page_size The number of packing options to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param page_size [Integer] The number of packing options to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingOptions" @@ -222,8 +219,8 @@ def list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil, # Generates available packing options for the inbound plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_packing_options(inbound_plan_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingOptions" @@ -234,9 +231,9 @@ def generate_packing_options(inbound_plan_id, rate_limit: 2.0) # Confirms the packing option for an inbound plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] packing_option_id Identifier of a packing option. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param packing_option_id [String] Identifier of a packing option. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_packing_option(inbound_plan_id, packing_option_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/packingOptions/#{packing_option_id}/confirmation" @@ -248,12 +245,12 @@ def confirm_packing_option(inbound_plan_id, packing_option_id, rate_limit: 2.0) # related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Integer] page_size The number of pallets to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param page_size [Integer] The number of pallets to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/pallets" @@ -269,12 +266,12 @@ def list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: # corresponding operation before becoming available. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Integer] page_size The number of placement options to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param page_size [Integer] The number of placement options to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/placementOptions" @@ -289,9 +286,9 @@ def list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil # Generates placement options for the inbound plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Hash] body The body of the request to `generatePlacementOptions`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param body [Hash] The body of the request to `generatePlacementOptions`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_placement_options(inbound_plan_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/placementOptions" @@ -302,10 +299,10 @@ def generate_placement_options(inbound_plan_id, body, rate_limit: 2.0) # Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] placement_option_id The identifier of a placement option. A placement option represents the + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param placement_option_id [String] The identifier of a placement option. A placement option represents the # shipment splits and destinations of SKUs. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_placement_option(inbound_plan_id, placement_option_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/placementOptions/#{placement_option_id}/confirmation" @@ -317,9 +314,9 @@ def confirm_placement_option(inbound_plan_id, placement_option_id, rate_limit: 2 # `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment(inbound_plan_id, shipment_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}" @@ -330,13 +327,13 @@ def get_shipment(inbound_plan_id, shipment_id, rate_limit: 2.0) # Provides a paginated list of box packages in a shipment. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Integer] page_size The number of boxes to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param page_size [Integer] The number of boxes to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/boxes" @@ -353,17 +350,16 @@ def list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_ # of the change that can only be confirmed prior to the expiry date specified. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Integer] page_size The number of content update previews to return. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param page_size [Integer] The number of content update previews to return. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews" params = { "pageSize" => page_size, @@ -378,10 +374,10 @@ def list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_siz # prior to confirmation. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Hash] body The body of the request to `generateShipmentContentUpdatePreviews`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param body [Hash] The body of the request to `generateShipmentContentUpdatePreviews`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews" @@ -394,14 +390,12 @@ def generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body # date specified. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [String] content_update_preview_id Identifier of a content update preview. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param content_update_preview_id [String] Identifier of a content update preview. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response - def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id, - rate_limit: 2.0) - + def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews/#{content_update_preview_id}" meter(rate_limit).get(path) @@ -410,14 +404,13 @@ def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_up # Confirm a shipment content update preview and accept the changes in transportation cost. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [String] content_update_preview_id Identifier of a content update preview. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param content_update_preview_id [String] Identifier of a content update preview. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/contentUpdatePreviews/#{content_update_preview_id}/confirmation" meter(rate_limit).post(path) @@ -426,9 +419,9 @@ def confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, conten # Provide delivery challan document for PCP transportation in IN marketplace. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_delivery_challan_document(inbound_plan_id, shipment_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryChallanDocument" @@ -440,18 +433,17 @@ def get_delivery_challan_document(inbound_plan_id, shipment_id, rate_limit: 2.0) # `generateDeliveryWindowOptions` operation before becoming available. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id The shipment to get delivery window options for. - # @param [Integer] page_size The number of delivery window options to return in the response matching the given + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] The shipment to get delivery window options for. + # @param page_size [Integer] The number of delivery window options to return in the response matching the given # query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryWindowOptions" params = { "pageSize" => page_size, @@ -464,9 +456,9 @@ def list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pa # Generates available delivery window options for a given shipment. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id The shipment to generate delivery window options for. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] The shipment to generate delivery window options for. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_delivery_window_options(inbound_plan_id, shipment_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryWindowOptions" @@ -482,10 +474,10 @@ def generate_delivery_window_options(inbound_plan_id, shipment_id, rate_limit: 2 # confirmation. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id The shipment to confirm the delivery window option for. - # @param [String] delivery_window_option_id The id of the delivery window option to be confirmed. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] The shipment to confirm the delivery window option for. + # @param delivery_window_option_id [String] The id of the delivery window option to be confirmed. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/deliveryWindowOptions/#{delivery_window_option_id}/confirmation" @@ -496,13 +488,13 @@ def confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_windo # Provides a paginated list of item packages in a shipment. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Integer] page_size The number of items to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param page_size [Integer] The number of items to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/items" @@ -517,10 +509,10 @@ def list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_ # Updates the name of an existing shipment. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Hash] body The body of the request to `updateShipmentName`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param body [Hash] The body of the request to `updateShipmentName`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_shipment_name(inbound_plan_id, shipment_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/name" @@ -532,13 +524,13 @@ def update_shipment_name(inbound_plan_id, shipment_id, body, rate_limit: 2.0) # related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Integer] page_size The number of pallets to return in the response matching the given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param page_size [Integer] The number of pallets to return in the response matching the given query. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/pallets" @@ -553,10 +545,10 @@ def list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, paginatio # Cancels a self-ship appointment slot against a shipment. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Hash] body The body of the request to `cancelSelfShipAppointment`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param body [Hash] The body of the request to `cancelSelfShipAppointment`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_self_ship_appointment(inbound_plan_id, shipment_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentCancellation" @@ -567,18 +559,17 @@ def cancel_self_ship_appointment(inbound_plan_id, shipment_id, body, rate_limit: # Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Integer] page_size The number of self ship appointment slots to return in the response matching the + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param page_size [Integer] The number of self ship appointment slots to return in the response matching the # given query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentSlots" params = { "pageSize" => page_size, @@ -591,10 +582,10 @@ def get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, # Initiates the process of generating the appointment slots list. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Hash] body The body of the request to `generateSelfShipAppointmentSlots`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param body [Hash] The body of the request to `generateSelfShipAppointmentSlots`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentSlots" @@ -605,11 +596,11 @@ def generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body, rat # Confirms or reschedules a self-ship appointment slot against a shipment. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [String] slot_id An identifier to a self-ship appointment slot. - # @param [Hash] body The body of the request to `scheduleSelfShipAppointment`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param slot_id [String] An identifier to a self-ship appointment slot. + # @param body [Hash] The body of the request to `scheduleSelfShipAppointment`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/selfShipAppointmentSlots/#{slot_id}/schedule" @@ -623,10 +614,10 @@ def schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body, # transportation options and quotes due to the new source address. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Hash] body The body of the request to `updateShipmentSourceAddress`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param body [Hash] The body of the request to `updateShipmentSourceAddress`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_shipment_source_address(inbound_plan_id, shipment_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/sourceAddress" @@ -637,10 +628,10 @@ def update_shipment_source_address(inbound_plan_id, shipment_id, body, rate_limi # Updates a shipment's tracking details. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [String] shipment_id Identifier of a shipment. A shipment contains the boxes and units being inbounded. - # @param [Hash] body The body of the request to `updateShipmentTrackingDetails`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param shipment_id [String] Identifier of a shipment. A shipment contains the boxes and units being inbounded. + # @param body [Hash] The body of the request to `updateShipmentTrackingDetails`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_shipment_tracking_details(inbound_plan_id, shipment_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/shipments/#{shipment_id}/trackingDetails" @@ -652,21 +643,20 @@ def update_shipment_tracking_details(inbound_plan_id, shipment_id, body, rate_li # `generateTransportationOptions` operation before becoming available. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Integer] page_size The number of transportation options to return in the response matching the given + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param page_size [Integer] The number of transportation options to return in the response matching the given # query. - # @param [String] pagination_token A token to fetch a certain page when there are multiple pages worth of results. + # @param pagination_token [String] A token to fetch a certain page when there are multiple pages worth of results. # The value of this token is fetched from the `pagination` returned in the API response. In the absence of the # token value from the query parameter the API returns the first page of the result. - # @param [String] placement_option_id The placement option to get transportation options for. Either + # @param placement_option_id [String] The placement option to get transportation options for. Either # `placementOptionId` or `shipmentId` must be specified. - # @param [String] shipment_id The shipment to get transportation options for. Either `placementOptionId` or + # @param shipment_id [String] The shipment to get transportation options for. Either `placementOptionId` or # `shipmentId` must be specified. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_transportation_options(inbound_plan_id, page_size: 10, pagination_token: nil, placement_option_id: nil, shipment_id: nil, rate_limit: 2.0) - path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/transportationOptions" params = { "pageSize" => page_size, @@ -681,9 +671,9 @@ def list_transportation_options(inbound_plan_id, page_size: 10, pagination_token # Generates available transportation options for a given placement option. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Hash] body The body of the request to `generateTransportationOptions`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param body [Hash] The body of the request to `generateTransportationOptions`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_transportation_options(inbound_plan_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/transportationOptions" @@ -695,9 +685,9 @@ def generate_transportation_options(inbound_plan_id, body, rate_limit: 2.0) # of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. # # @note This operation can make a static sandbox call. - # @param [String] inbound_plan_id Identifier of an inbound plan. - # @param [Hash] body The body of the request to `confirmTransportationOptions`. - # @param [Float] rate_limit Requests per second + # @param inbound_plan_id [String] Identifier of an inbound plan. + # @param body [Hash] The body of the request to `confirmTransportationOptions`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_transportation_options(inbound_plan_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/inboundPlans/#{inbound_plan_id}/transportationOptions/confirmation" @@ -708,10 +698,10 @@ def confirm_transportation_options(inbound_plan_id, body, rate_limit: 2.0) # List the inbound compliance details for MSKUs in a given marketplace. # # @note This operation can make a static sandbox call. - # @param [Array] mskus List of merchant SKUs - a merchant-supplied identifier for a specific SKU. - # @param [String] marketplace_id The Marketplace ID. Refer to [Marketplace + # @param mskus [Array] List of merchant SKUs - a merchant-supplied identifier for a specific SKU. + # @param marketplace_id [String] The Marketplace ID. Refer to [Marketplace # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_item_compliance_details(mskus, marketplace_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/items/compliance" @@ -727,10 +717,10 @@ def list_item_compliance_details(mskus, marketplace_id, rate_limit: 2.0) # compliance validation. # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id The Marketplace ID. Refer to [Marketplace + # @param marketplace_id [String] The Marketplace ID. Refer to [Marketplace # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. - # @param [Hash] body The body of the request to `updateItemComplianceDetails`. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The body of the request to `updateItemComplianceDetails`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_item_compliance_details(marketplace_id, body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/items/compliance" @@ -744,8 +734,8 @@ def update_item_compliance_details(marketplace_id, body, rate_limit: 2.0) # For a given marketplace - creates labels for a list of mskus. # # @note This operation can make a static sandbox call. - # @param [Hash] body The body of the request to `createMarketplaceItemLabels`. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The body of the request to `createMarketplaceItemLabels`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_marketplace_item_labels(body, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/items/labels" @@ -756,8 +746,8 @@ def create_marketplace_item_labels(body, rate_limit: 2.0) # Gets the status of the processing of an asynchronous API call. # # @note This operation can make a static sandbox call. - # @param [String] operation_id Identifier of an asynchronous operation. - # @param [Float] rate_limit Requests per second + # @param operation_id [String] Identifier of an asynchronous operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_inbound_operation_status(operation_id, rate_limit: 2.0) path = "/inbound/fba/2024-03-20/operations/#{operation_id}" diff --git a/lib/peddler/api/fulfillment_inbound_v0.rb b/lib/peddler/api/fulfillment_inbound_v0.rb index 93e562a7..0dcfdef9 100644 --- a/lib/peddler/api/fulfillment_inbound_v0.rb +++ b/lib/peddler/api/fulfillment_inbound_v0.rb @@ -23,8 +23,8 @@ class FulfillmentInboundV0 < API # be shipped separately from stickerless, commingled inventory. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request schema for the CreateInboundShipmentPlanRequest operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request schema for the CreateInboundShipmentPlanRequest operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_inbound_shipment_plan(body, rate_limit: 2.0) path = "/fba/inbound/v0/plans" @@ -36,10 +36,10 @@ def create_inbound_shipment_plan(body, rate_limit: 2.0) # createInboundShipmentPlan operation. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request schema for the InboundShipmentRequest operation. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param body [Hash] The request schema for the InboundShipmentRequest operation. + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_inbound_shipment(body, shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}" @@ -51,10 +51,10 @@ def create_inbound_shipment(body, shipment_id, rate_limit: 2.0) # items is not supported. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request schema for the InboundShipmentRequest operation. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param body [Hash] The request schema for the InboundShipmentRequest operation. + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_inbound_shipment(body, shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}" @@ -65,10 +65,10 @@ def update_inbound_shipment(body, shipment_id, rate_limit: 2.0) # Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace the shipment is tied to. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace the shipment is tied to. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder" @@ -83,13 +83,13 @@ def get_preorder_info(shipment_id, marketplace_id, rate_limit: 2.0) # getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [String] need_by_date Date that the shipment must arrive at the Amazon fulfillment center to avoid + # @param need_by_date [String] Date that the shipment must arrive at the Amazon fulfillment center to avoid # delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the # getPreorderInfo operation returns this value. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace the shipment is tied to. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace the shipment is tied to. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/preorder/confirm" @@ -105,21 +105,21 @@ def confirm_preorder(shipment_id, need_by_date, marketplace_id, rate_limit: 2.0) # fulfillment network. # # @note This operation can make a static sandbox call. - # @param [String] ship_to_country_code The country code of the country to which the items will be shipped. Note + # @param ship_to_country_code [String] The country code of the country to which the items will be shipped. Note # that labeling requirements and item preparation instructions can vary by country. - # @param [Array] seller_sku_list A list of SellerSKU values. Used to identify items for which you want + # @param seller_sku_list [Array] A list of SellerSKU values. Used to identify items for which you want # labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The # SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: # Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU # that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the # InvalidSKUList property in the response. - # @param [Array] asin_list A list of ASIN values. Used to identify items for which you want item + # @param asin_list [Array] A list of ASIN values. Used to identify items for which you want item # preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product # catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in # the product catalog for at least one of the marketplaces that the seller participates in is returned in the # InvalidASINList property in the response. You can find out which marketplaces a seller participates in by # calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: nil, rate_limit: 2.0) path = "/fba/inbound/v0/prepInstructions" @@ -135,9 +135,9 @@ def get_prep_instructions(ship_to_country_code, seller_sku_list: nil, asin_list: # Returns current transportation information about an inbound shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_transport_details(shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/transport" @@ -148,10 +148,10 @@ def get_transport_details(shipment_id, rate_limit: 2.0) # Sends transportation information to Amazon about an inbound shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Hash] body The request schema for the PutTransportDetailsRequest operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request schema for the PutTransportDetailsRequest operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def put_transport_details(shipment_id, body, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/transport" @@ -167,9 +167,9 @@ def put_transport_details(shipment_id, body, rate_limit: 2.0) # cost. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def void_transport(shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/void" @@ -182,9 +182,9 @@ def void_transport(shipment_id, rate_limit: 2.0) # Amazon with the transportation information for the inbound shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def estimate_transport(shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/estimate" @@ -203,9 +203,9 @@ def estimate_transport(shipment_id, rate_limit: 2.0) # to void it. After the grace period has expired the seller's account will be charged for the shipping cost. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_transport(shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/transport/confirm" @@ -216,26 +216,25 @@ def confirm_transport(shipment_id, rate_limit: 2.0) # Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [String] page_type The page type to use to print the labels. Submitting a PageType value that is not + # @param page_type [String] The page type to use to print the labels. Submitting a PageType value that is not # supported in your marketplace returns an error. - # @param [String] label_type The type of labels requested. - # @param [Integer] number_of_packages The number of packages in the shipment. - # @param [Array] package_labels_to_print A list of identifiers that specify packages for which you want + # @param label_type [String] The type of labels requested. + # @param number_of_packages [Integer] The number of packages in the shipment. + # @param package_labels_to_print [Array] A list of identifiers that specify packages for which you want # package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton # Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code. - # @param [Integer] number_of_pallets The number of pallets in the shipment. This returns four identical labels for + # @param number_of_pallets [Integer] The number of pallets in the shipment. This returns four identical labels for # each pallet. - # @param [Integer] page_size The page size for paginating through the total packages' labels. This is a required + # @param page_size [Integer] The page size for paginating through the total packages' labels. This is a required # parameter for Non-Partnered LTL Shipments. Max value:1000. - # @param [Integer] page_start_index The page start index for paginating through the total packages' labels. This + # @param page_start_index [Integer] The page start index for paginating through the total packages' labels. This # is a required parameter for Non-Partnered LTL Shipments. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_labels(shipment_id, page_type, label_type, number_of_packages: nil, package_labels_to_print: nil, number_of_pallets: nil, page_size: nil, page_start_index: nil, rate_limit: 2.0) - path = "/fba/inbound/v0/shipments/#{shipment_id}/labels" params = { "PageType" => page_type, @@ -255,9 +254,9 @@ def get_labels(shipment_id, page_type, label_type, number_of_packages: nil, pack # Truckload/Full Truckload (LTL/FTL) inbound shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier originally returned by the createInboundShipmentPlan + # @param shipment_id [String] A shipment identifier originally returned by the createInboundShipmentPlan # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_bill_of_lading(shipment_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/billOfLading" @@ -268,27 +267,26 @@ def get_bill_of_lading(shipment_id, rate_limit: 2.0) # Returns a list of inbound shipments based on criteria that you specify. # # @note This operation can make a static sandbox call. - # @param [Array] shipment_status_list A list of ShipmentStatus values. Used to select shipments with a + # @param shipment_status_list [Array] A list of ShipmentStatus values. Used to select shipments with a # current status that matches the status values that you specify. - # @param [Array] shipment_id_list A list of shipment IDs used to select the shipments that you want. If + # @param shipment_id_list [Array] A list of shipment IDs used to select the shipments that you want. If # both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are # returned. - # @param [String] last_updated_after A date used for selecting inbound shipments that were last updated after (or + # @param last_updated_after [String] A date used for selecting inbound shipments that were last updated after (or # at) a specified time. The selection includes updates made by Amazon and by the seller. - # @param [String] last_updated_before A date used for selecting inbound shipments that were last updated before + # @param last_updated_before [String] A date used for selecting inbound shipments that were last updated before # (or at) a specified time. The selection includes updates made by Amazon and by the seller. - # @param [String] query_type Indicates whether shipments are returned using shipment information (by providing the + # @param query_type [String] Indicates whether shipments are returned using shipment information (by providing the # ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and # LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous # request. - # @param [String] next_token A string token returned in the response to your previous request. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace where the product would be + # @param next_token [String] A string token returned in the response to your previous request. + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be # stored. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipments(query_type, marketplace_id, shipment_status_list: nil, shipment_id_list: nil, last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0) - path = "/fba/inbound/v0/shipments" params = { "ShipmentStatusList" => shipment_status_list, @@ -306,10 +304,10 @@ def get_shipments(query_type, marketplace_id, shipment_status_list: nil, shipmen # Returns a list of items in a specified inbound shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id A shipment identifier used for selecting items in a specific inbound shipment. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace where the product would be + # @param shipment_id [String] A shipment identifier used for selecting items in a specific inbound shipment. + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be # stored. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment_items_by_shipment_id(shipment_id, marketplace_id, rate_limit: 2.0) path = "/fba/inbound/v0/shipments/#{shipment_id}/items" @@ -324,21 +322,20 @@ def get_shipment_items_by_shipment_id(shipment_id, marketplace_id, rate_limit: 2 # time frame. # # @note This operation can make a static sandbox call. - # @param [String] last_updated_after A date used for selecting inbound shipment items that were last updated after + # @param last_updated_after [String] A date used for selecting inbound shipment items that were last updated after # (or at) a specified time. The selection includes updates made by Amazon and by the seller. - # @param [String] last_updated_before A date used for selecting inbound shipment items that were last updated + # @param last_updated_before [String] A date used for selecting inbound shipment items that were last updated # before (or at) a specified time. The selection includes updates made by Amazon and by the seller. - # @param [String] query_type Indicates whether items are returned using a date range (by providing the + # @param query_type [String] Indicates whether items are returned using a date range (by providing the # LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items # specified in a previous request. - # @param [String] next_token A string token returned in the response to your previous request. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace where the product would be + # @param next_token [String] A string token returned in the response to your previous request. + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace where the product would be # stored. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment_items(query_type, marketplace_id, last_updated_after: nil, last_updated_before: nil, next_token: nil, rate_limit: 2.0) - path = "/fba/inbound/v0/shipmentItems" params = { "LastUpdatedAfter" => last_updated_after, diff --git a/lib/peddler/api/fulfillment_outbound_2020_07_01.rb b/lib/peddler/api/fulfillment_outbound_2020_07_01.rb index 6b7a50d5..093fc8e6 100644 --- a/lib/peddler/api/fulfillment_outbound_2020_07_01.rb +++ b/lib/peddler/api/fulfillment_outbound_2020_07_01.rb @@ -19,8 +19,8 @@ class FulfillmentOutbound20200701 < API # Returns a list of fulfillment order previews based on shipping criteria that you specify. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body GetFulfillmentPreviewRequest parameter - # @param [Float] rate_limit Requests per second + # @param body [Hash] GetFulfillmentPreviewRequest parameter + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_fulfillment_preview(body, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/preview" @@ -32,8 +32,8 @@ def get_fulfillment_preview(body, rate_limit: 2.0) # you specify. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body GetDeliveryOffersRequest parameter - # @param [Float] rate_limit Requests per second + # @param body [Hash] GetDeliveryOffersRequest parameter + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def delivery_offers(body, rate_limit: 5.0) path = "/fba/outbound/2020-07-01/deliveryOffers" @@ -45,11 +45,11 @@ def delivery_offers(body, rate_limit: 5.0) # token parameter. # # @note This operation can make a dynamic sandbox call. - # @param [String] query_start_date A date used to select fulfillment orders that were last updated after (or at) a + # @param query_start_date [String] A date used to select fulfillment orders that were last updated after (or at) a # specified time. An update is defined as any change in fulfillment order status, including the creation of a # new fulfillment order. - # @param [String] next_token A string token returned in the response to your previous request. - # @param [Float] rate_limit Requests per second + # @param next_token [String] A string token returned in the response to your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_all_fulfillment_orders(query_start_date: nil, next_token: nil, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders" @@ -65,8 +65,8 @@ def list_all_fulfillment_orders(query_start_date: nil, next_token: nil, rate_lim # address. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body CreateFulfillmentOrderRequest parameter - # @param [Float] rate_limit Requests per second + # @param body [Hash] CreateFulfillmentOrderRequest parameter + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_fulfillment_order(body, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders" @@ -78,9 +78,9 @@ def create_fulfillment_order(body, rate_limit: 2.0) # order. # # @note This operation can make a dynamic sandbox call. - # @param [Integer] package_number The unencrypted package identifier returned by the `getFulfillmentOrder` + # @param package_number [Integer] The unencrypted package identifier returned by the `getFulfillmentOrder` # operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_package_tracking_details(package_number, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/tracking" @@ -96,18 +96,17 @@ def get_package_tracking_details(package_number, rate_limit: 2.0) # [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a dynamic sandbox call. - # @param [String] seller_sku The seller SKU for which return reason codes are required. - # @param [String] marketplace_id The marketplace for which the seller wants return reason codes. - # @param [String] seller_fulfillment_order_id The identifier assigned to the item by the seller when the + # @param seller_sku [String] The seller SKU for which return reason codes are required. + # @param marketplace_id [String] The marketplace for which the seller wants return reason codes. + # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the # fulfillment order was created. The service uses this value to determine the marketplace for which the seller # wants return reason codes. - # @param [String] language The language that the `TranslatedDescription` property of the `ReasonCodeDetails` + # @param language [String] The language that the `TranslatedDescription` property of the `ReasonCodeDetails` # response object should be translated into. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_return_reason_codes(seller_sku, marketplace_id: nil, seller_fulfillment_order_id: nil, language: nil, rate_limit: 2.0) - path = "/fba/outbound/2020-07-01/returnReasonCodes" params = { "sellerSku" => seller_sku, @@ -122,11 +121,11 @@ def list_return_reason_codes(seller_sku, marketplace_id: nil, seller_fulfillment # Creates a fulfillment return. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body CreateFulfillmentReturnRequest parameter - # @param [String] seller_fulfillment_order_id An identifier assigned by the seller to the fulfillment order at the + # @param body [Hash] CreateFulfillmentReturnRequest parameter + # @param seller_fulfillment_order_id [String] An identifier assigned by the seller to the fulfillment order at the # time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value # based on the buyer's request to return items. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_fulfillment_return(body, seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}/return" @@ -137,9 +136,9 @@ def create_fulfillment_return(body, seller_fulfillment_order_id, rate_limit: 2.0 # Returns the fulfillment order indicated by the specified order identifier. # # @note This operation can make a dynamic sandbox call. - # @param [String] seller_fulfillment_order_id The identifier assigned to the item by the seller when the + # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the # fulfillment order was created. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}" @@ -150,10 +149,10 @@ def get_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) # Updates and/or requests shipment for a fulfillment order with an order hold on it. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body UpdateFulfillmentOrderRequest parameter - # @param [String] seller_fulfillment_order_id The identifier assigned to the item by the seller when the + # @param body [Hash] UpdateFulfillmentOrderRequest parameter + # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the # fulfillment order was created. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_fulfillment_order(body, seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}" @@ -165,9 +164,9 @@ def update_fulfillment_order(body, seller_fulfillment_order_id, rate_limit: 2.0) # identifier. # # @note This operation can make a dynamic sandbox call. - # @param [String] seller_fulfillment_order_id The identifier assigned to the item by the seller when the + # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the # fulfillment order was created. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}/cancel" @@ -182,10 +181,10 @@ def cancel_fulfillment_order(seller_fulfillment_order_id, rate_limit: 2.0) # information. # # @note This operation can make a dynamic sandbox call. - # @param [String] seller_fulfillment_order_id The identifier assigned to the item by the seller when the + # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the # fulfillment order was created. - # @param [Hash] body The identifier assigned to the item by the seller when the fulfillment order was created. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The identifier assigned to the item by the seller when the fulfillment order was created. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_fulfillment_order_status_update(seller_fulfillment_order_id, body, rate_limit: nil) must_sandbox! @@ -199,8 +198,8 @@ def submit_fulfillment_order_status_update(seller_fulfillment_order_id, body, ra # whether the seller for which you made the call is enrolled for each feature. # # @note This operation can make a dynamic sandbox call. - # @param [String] marketplace_id The marketplace for which to return the list of features. - # @param [Float] rate_limit Requests per second + # @param marketplace_id [String] The marketplace for which to return the list of features. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_features(marketplace_id, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/features" @@ -214,15 +213,15 @@ def get_features(marketplace_id, rate_limit: 2.0) # Returns a list of inventory items that are eligible for the fulfillment feature you specify. # # @note This operation can make a dynamic sandbox call. - # @param [String] marketplace_id The marketplace for which to return a list of the inventory that is eligible for + # @param marketplace_id [String] The marketplace for which to return a list of the inventory that is eligible for # the specified feature. - # @param [String] feature_name The name of the feature for which to return a list of eligible inventory. - # @param [String] next_token A string token returned in the response to your previous request that is used to + # @param feature_name [String] The name of the feature for which to return a list of eligible inventory. + # @param next_token [String] A string token returned in the response to your previous request that is used to # return the next response page. A value of null will return the first page. - # @param [String] query_start_date A date that you can use to select inventory that has been updated since a + # @param query_start_date [String] A date that you can use to select inventory that has been updated since a # specified date. An update is defined as any change in feature-enabled inventory availability. The date must be # in the format yyyy-MM-ddTHH:mm:ss.sssZ - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_feature_inventory(marketplace_id, feature_name, next_token: nil, query_start_date: nil, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/features/inventory/#{feature_name}" @@ -241,11 +240,11 @@ def get_feature_inventory(marketplace_id, feature_name, next_token: nil, query_s # SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a dynamic sandbox call. - # @param [String] marketplace_id The marketplace for which to return the count. - # @param [String] feature_name The name of the feature. - # @param [String] seller_sku Used to identify an item in the given marketplace. `SellerSKU` is qualified by the + # @param marketplace_id [String] The marketplace for which to return the count. + # @param feature_name [String] The name of the feature. + # @param seller_sku [String] Used to identify an item in the given marketplace. `SellerSKU` is qualified by the # seller's `SellerId`, which is included with every operation that you submit. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_feature_sku(marketplace_id, feature_name, seller_sku, rate_limit: 2.0) path = "/fba/outbound/2020-07-01/features/inventory/#{feature_name}/#{seller_sku}" diff --git a/lib/peddler/api/listings_items_2020_09_01.rb b/lib/peddler/api/listings_items_2020_09_01.rb index 34548d64..5c4b59b2 100644 --- a/lib/peddler/api/listings_items_2020_09_01.rb +++ b/lib/peddler/api/listings_items_2020_09_01.rb @@ -15,22 +15,21 @@ class API # The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner # listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which # you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more - # information, see the [Listing Items API Use Case - # Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2020-09-01-use-case-guide). + # information, see the {Listing Items API Use Case Guide + # https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2020-09-01-use-case-guide}. class ListingsItems20200901 < API - # Delete a listings item for a selling partner. - # @note The parameters associated with this operation may contain special characters that must be encoded to - # successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may + # contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when + # encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [String] sku A selling partner provided identifier for an Amazon listing. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param sku [String] A selling partner provided identifier for an Amazon listing. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" # when a localization is not available in the specified locale. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rate_limit: 5.0) path = "/listings/2020-09-01/items/#{seller_id}/#{sku}" @@ -43,20 +42,19 @@ def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rat end # Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be - # patched. Patching nested attributes is not supported. - # @note The parameters associated with this operation may contain special characters that must be encoded to - # successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # patched. Patching nested attributes is not supported. **Note:** The parameters associated with this operation + # may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when + # encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [String] sku A selling partner provided identifier for an Amazon listing. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param sku [String] A selling partner provided identifier for an Amazon listing. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" # when a localization is not available in the specified locale. - # @param [Hash] body The request body schema for the patchListingsItem operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body schema for the patchListingsItem operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def patch_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0) path = "/listings/2020-09-01/items/#{seller_id}/#{sku}" @@ -68,20 +66,20 @@ def patch_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil meter(rate_limit).patch(path, body:, params:) end - # Creates a new or fully-updates an existing listings item for a selling partner. - # @note The parameters associated with this operation may contain special characters that must be encoded to - # successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Creates a new or fully-updates an existing listings item for a selling partner. **Note:** The parameters + # associated with this operation may contain special characters that must be encoded to successfully call the API. + # To avoid errors with SKUs when encoding URLs, refer to [URL + # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [String] sku A selling partner provided identifier for an Amazon listing. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param sku [String] A selling partner provided identifier for an Amazon listing. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" # when a localization is not available in the specified locale. - # @param [Hash] body The request body schema for the putListingsItem operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body schema for the putListingsItem operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def put_listings_item(seller_id, sku, marketplace_ids, body, issue_locale: nil, rate_limit: 5.0) path = "/listings/2020-09-01/items/#{seller_id}/#{sku}" diff --git a/lib/peddler/api/listings_items_2021_08_01.rb b/lib/peddler/api/listings_items_2021_08_01.rb index b071bbfa..2a769799 100644 --- a/lib/peddler/api/listings_items_2021_08_01.rb +++ b/lib/peddler/api/listings_items_2021_08_01.rb @@ -18,19 +18,18 @@ class API # information, see the [Listings Items API Use Case # Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide). class ListingsItems20210801 < API - # Delete a listings item for a selling partner. - # @note The parameters associated with this operation may contain special characters that must be encoded to - # successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may + # contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when + # encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [String] sku A selling partner provided identifier for an Amazon listing. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param sku [String] A selling partner provided identifier for an Amazon listing. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` # when a localization is not available in the specified locale. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rate_limit: 5.0) path = "/listings/2021-08-01/items/#{seller_id}/#{sku}" @@ -42,25 +41,23 @@ def delete_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, rat meter(rate_limit).delete(path, params:) end - # Returns details about a listings item for a selling partner. - # @note The parameters associated with this operation may contain special characters that must be encoded to - # successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Returns details about a listings item for a selling partner. **Note:** The parameters associated with this + # operation may contain special characters that must be encoded to successfully call the API. To avoid errors with + # SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [String] sku A selling partner provided identifier for an Amazon listing. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param sku [String] A selling partner provided identifier for an Amazon listing. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` # when a localization is not available in the specified locale. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # `summaries`. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, included_data: ["summaries"], rate_limit: 5.0) - path = "/listings/2021-08-01/items/#{seller_id}/#{sku}" params = { "marketplaceIds" => marketplace_ids, @@ -72,28 +69,26 @@ def get_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, includ end # Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be - # patched. Patching nested attributes is not supported. - # @note This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. - # @note The parameters associated with this operation may contain special characters that must be encoded to - # successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # patched. Patching nested attributes is not supported. **Note:** This operation has a throttling rate of one + # request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation + # may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when + # encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [String] sku A selling partner provided identifier for an Amazon listing. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param sku [String] A selling partner provided identifier for an Amazon listing. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # `issues`. - # @param [String] mode The mode of operation for the request. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param mode [String] The mode of operation for the request. + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` # when a localization is not available in the specified locale. - # @param [Hash] body The request body schema for the `patchListingsItem` operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body schema for the `patchListingsItem` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def patch_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil, issue_locale: nil, rate_limit: 5.0) - path = "/listings/2021-08-01/items/#{seller_id}/#{sku}" params = { "marketplaceIds" => marketplace_ids, @@ -105,28 +100,27 @@ def patch_listings_item(seller_id, sku, marketplace_ids, body, included_data: [" meter(rate_limit).patch(path, body:, params:) end - # Creates or fully updates an existing listings item for a selling partner. - # @note This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. - # @note The parameters associated with this operation may contain special characters that must be encoded to - # successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a + # throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters + # associated with this operation may contain special characters that must be encoded to successfully call the API. + # To avoid errors with SKUs when encoding URLs, refer to [URL + # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [String] sku A selling partner provided identifier for an Amazon listing. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param sku [String] A selling partner provided identifier for an Amazon listing. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # `issues`. - # @param [String] mode The mode of operation for the request. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param mode [String] The mode of operation for the request. + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` # when a localization is not available in the specified locale. - # @param [Hash] body The request body schema for the `putListingsItem` operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body schema for the `putListingsItem` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def put_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["issues"], mode: nil, issue_locale: nil, rate_limit: 5.0) - path = "/listings/2021-08-01/items/#{seller_id}/#{sku}" params = { "marketplaceIds" => marketplace_ids, @@ -141,24 +135,23 @@ def put_listings_item(seller_id, sku, marketplace_ids, body, included_data: ["is # Search for and return list of listings items and respective details for a selling partner. # # @note This operation can make a static sandbox call. - # @param [String] seller_id A selling partner identifier, such as a merchant account or vendor code. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [Array] identifiers A comma-delimited list of product identifiers to search for listings items + # @param seller_id [String] A selling partner identifier, such as a merchant account or vendor code. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param identifiers [Array] A comma-delimited list of product identifiers to search for listings items # by. **Note**: 1. Required when `identifiersType` is provided. - # @param [String] identifiers_type Type of product identifiers to search for listings items by. **Note**: 1. + # @param identifiers_type [String] Type of product identifiers to search for listings items by. **Note**: 1. # Required when `identifiers` is provided. - # @param [Integer] page_size Number of results to be returned per page. - # @param [String] page_token A token to fetch a certain page when there are multiple pages worth of results. - # @param [Array] included_data A comma-delimited list of data sets to include in the response. Default: + # @param page_size [Integer] Number of results to be returned per page. + # @param page_token [String] A token to fetch a certain page when there are multiple pages worth of results. + # @param included_data [Array] A comma-delimited list of data sets to include in the response. Default: # summaries. - # @param [String] issue_locale A locale for localization of issues. When not provided, the default language code + # @param issue_locale [String] A locale for localization of issues. When not provided, the default language code # of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" # when a localization is not available in the specified locale. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def search_listings_items(seller_id, marketplace_ids, identifiers: nil, identifiers_type: nil, page_size: 10, page_token: nil, included_data: ["summaries"], issue_locale: nil, rate_limit: 5.0) - path = "/listings/2021-08-01/items/#{seller_id}" params = { "marketplaceIds" => marketplace_ids, diff --git a/lib/peddler/api/listings_restrictions_2021_08_01.rb b/lib/peddler/api/listings_restrictions_2021_08_01.rb index a566873b..35909957 100644 --- a/lib/peddler/api/listings_restrictions_2021_08_01.rb +++ b/lib/peddler/api/listings_restrictions_2021_08_01.rb @@ -13,24 +13,23 @@ class API # Selling Partner API for Listings Restrictions # # The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog - # listings. For more information, see the [Listings Restrictions API Use Case - # Guide](https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-use-case-guide). + # listings. For more information, see the {Listings Restrictions API Use Case Guide + # https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-use-case-guide}. class ListingsRestrictions20210801 < API # Returns listing restrictions for an item in the Amazon Catalog. # # @note This operation can make a static sandbox call. - # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item. - # @param [String] condition_type The condition used to filter restrictions. - # @param [String] seller_id A selling partner identifier, such as a merchant account. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [String] reason_locale A locale for reason text localization. When not provided, the default language + # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item. + # @param condition_type [String] The condition used to filter restrictions. + # @param seller_id [String] A selling partner identifier, such as a merchant account. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param reason_locale [String] A locale for reason text localization. When not provided, the default language # code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to # "en_US" when a localization is not available in the specified locale. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_listings_restrictions(asin, seller_id, marketplace_ids, condition_type: nil, reason_locale: nil, rate_limit: 5.0) - path = "/listings/2021-08-01/restrictions" params = { "asin" => asin, diff --git a/lib/peddler/api/merchant_fulfillment_v0.rb b/lib/peddler/api/merchant_fulfillment_v0.rb index 101ad582..6bc880d7 100644 --- a/lib/peddler/api/merchant_fulfillment_v0.rb +++ b/lib/peddler/api/merchant_fulfillment_v0.rb @@ -18,8 +18,8 @@ class MerchantFulfillmentV0 < API # Returns a list of shipping service offers that satisfy the specified shipment request details. # # @note This operation can make a static sandbox call. - # @param [Hash] body Request schema for GetEligibleShipmentServices operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request schema for GetEligibleShipmentServices operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_eligible_shipment_services(body, rate_limit: 5.0) path = "/mfn/v0/eligibleShippingServices" @@ -30,8 +30,8 @@ def get_eligible_shipment_services(body, rate_limit: 5.0) # Returns the shipment information for an existing shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id The Amazon-defined shipment identifier for the shipment. - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] The Amazon-defined shipment identifier for the shipment. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment(shipment_id, rate_limit: 1.0) path = "/mfn/v0/shipments/#{shipment_id}" @@ -42,8 +42,8 @@ def get_shipment(shipment_id, rate_limit: 1.0) # Cancel the shipment indicated by the specified shipment identifier. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id The Amazon-defined shipment identifier for the shipment to cancel. - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] The Amazon-defined shipment identifier for the shipment to cancel. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_shipment(shipment_id, rate_limit: 1.0) path = "/mfn/v0/shipments/#{shipment_id}" @@ -54,8 +54,8 @@ def cancel_shipment(shipment_id, rate_limit: 1.0) # Create a shipment with the information provided. # # @note This operation can make a static sandbox call. - # @param [Hash] body Request schema for CreateShipment operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request schema for CreateShipment operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_shipment(body, rate_limit: 1.0) path = "/mfn/v0/shipments" @@ -67,8 +67,8 @@ def create_shipment(body, rate_limit: 1.0) # shipping. # # @note This operation can make a static sandbox call. - # @param [Hash] body Request schema for GetAdditionalSellerInputs operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request schema for GetAdditionalSellerInputs operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_additional_seller_inputs(body, rate_limit: 1.0) path = "/mfn/v0/additionalSellerInputs" diff --git a/lib/peddler/api/messaging_v1.rb b/lib/peddler/api/messaging_v1.rb index 2304cf5d..14badbc0 100644 --- a/lib/peddler/api/messaging_v1.rb +++ b/lib/peddler/api/messaging_v1.rb @@ -22,11 +22,11 @@ class MessagingV1 < API # call an operation that sends a message. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which you want a list + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which you want a list # of available message types. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_messaging_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}" @@ -41,12 +41,12 @@ def get_messaging_actions_for_order(amazon_order_id, marketplace_ids, rate_limit # initials, etc. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_customization_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmCustomizationDetails" @@ -60,12 +60,12 @@ def confirm_customization_details(amazon_order_id, marketplace_ids, body, rate_l # Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_confirm_delivery_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmDeliveryDetails" @@ -80,12 +80,12 @@ def create_confirm_delivery_details(amazon_order_id, marketplace_ids, body, rate # This message should only be used to deliver documents that are required by law. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_legal_disclosure(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/legalDisclosure" @@ -100,11 +100,11 @@ def create_legal_disclosure(amazon_order_id, marketplace_ids, body, rate_limit: # sent after the seller has resolved the buyer's problem. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_negative_feedback_removal(amazon_order_id, marketplace_ids, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/negativeFeedbackRemoval" @@ -118,12 +118,12 @@ def create_negative_feedback_removal(amazon_order_id, marketplace_ids, rate_limi # Sends a message to ask a buyer an order-related question prior to shipping their order. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_confirm_order_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmOrderDetails" @@ -138,12 +138,12 @@ def create_confirm_order_details(amazon_order_id, marketplace_ids, body, rate_li # service call. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_confirm_service_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmServiceDetails" @@ -158,12 +158,12 @@ def create_confirm_service_details(amazon_order_id, marketplace_ids, body, rate_ # Amazon Motors sellers. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_amazon_motors(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/amazonMotors" @@ -177,12 +177,12 @@ def create_amazon_motors(amazon_order_id, marketplace_ids, body, rate_limit: 1.0 # Sends a message to a buyer to provide details about warranty information on a purchase in their order. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_warranty(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/warranty" @@ -196,11 +196,11 @@ def create_warranty(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) # Returns a response containing attributes related to an order. This includes buyer preferences. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_attributes(amazon_order_id, marketplace_ids, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/attributes" @@ -214,12 +214,12 @@ def get_attributes(amazon_order_id, marketplace_ids, rate_limit: 1.0) # Sends a message to a buyer to share a digital access key needed to utilize digital content in their order. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_digital_access_key(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/digitalAccessKey" @@ -234,12 +234,12 @@ def create_digital_access_key(amazon_order_id, marketplace_ids, body, rate_limit # order. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_unexpected_problem(amazon_order_id, marketplace_ids, body, rate_limit: 1.0) path = "/messaging/v1/orders/#{amazon_order_id}/messages/unexpectedProblem" @@ -253,12 +253,12 @@ def create_unexpected_problem(amazon_order_id, marketplace_ids, body, rate_limit # Sends a message providing the buyer an invoice # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a message is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def send_invoice(amazon_order_id, marketplace_ids, body, rate_limit: nil) path = "/messaging/v1/orders/#{amazon_order_id}/messages/invoice" diff --git a/lib/peddler/api/notifications_v1.rb b/lib/peddler/api/notifications_v1.rb index 81c3d249..483cdc2d 100644 --- a/lib/peddler/api/notifications_v1.rb +++ b/lib/peddler/api/notifications_v1.rb @@ -23,9 +23,9 @@ class NotificationsV1 < API # subscription identifier. # # @note This operation can make a static sandbox call. - # @param [String] payload_version The version of the payload object to be used in the notification. - # @param [Float] rate_limit Requests per second - # @param [String] notification_type The type of notification. For more information about notification types, refer + # @param payload_version [String] The version of the payload object to be used in the notification. + # @param rate_limit [Float] Requests per second + # @param notification_type [String] The type of notification. For more information about notification types, refer # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). # @return [Hash] The API response def get_subscription(notification_type, payload_version: nil, rate_limit: 1.0) @@ -43,9 +43,9 @@ def get_subscription(notification_type, payload_version: nil, rate_limit: 1.0) # to a different payload version if you already have an existing subscription for a different payload version. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [Float] rate_limit Requests per second - # @param [String] notification_type The type of notification. For more information about notification types, refer + # @param body [Hash] + # @param rate_limit [Float] Requests per second + # @param notification_type [String] The type of notification. For more information about notification types, refer # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). # @return [Hash] The API response def create_subscription(body, notification_type, rate_limit: 1.0) @@ -59,9 +59,9 @@ def create_subscription(body, notification_type, rate_limit: 1.0) # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). # # @note This operation can make a static sandbox call. - # @param [String] subscription_id The identifier for the subscription that you want to get. - # @param [Float] rate_limit Requests per second - # @param [String] notification_type The type of notification. For more information about notification types, refer + # @param subscription_id [String] The identifier for the subscription that you want to get. + # @param rate_limit [Float] Requests per second + # @param notification_type [String] The type of notification. For more information about notification types, refer # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). # @return [Hash] The API response def get_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0) @@ -77,9 +77,9 @@ def get_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0) # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). # # @note This operation can make a static sandbox call. - # @param [String] subscription_id The identifier for the subscription that you want to delete. - # @param [Float] rate_limit Requests per second - # @param [String] notification_type The type of notification. For more information about notification types, refer + # @param subscription_id [String] The identifier for the subscription that you want to delete. + # @param rate_limit [Float] Requests per second + # @param notification_type [String] The type of notification. For more information about notification types, refer # to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). # @return [Hash] The API response def delete_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0) @@ -92,7 +92,7 @@ def delete_subscription_by_id(subscription_id, notification_type, rate_limit: 1. # refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). # # @note This operation can make a static sandbox call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_destinations(rate_limit: 1.0) path = "/notifications/v1/destinations" @@ -105,8 +105,8 @@ def get_destinations(rate_limit: 1.0) # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_destination(body, rate_limit: 1.0) path = "/notifications/v1/destinations" @@ -119,8 +119,8 @@ def create_destination(body, rate_limit: 1.0) # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). # # @note This operation can make a static sandbox call. - # @param [String] destination_id The identifier generated when you created the destination. - # @param [Float] rate_limit Requests per second + # @param destination_id [String] The identifier generated when you created the destination. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_destination(destination_id, rate_limit: 1.0) path = "/notifications/v1/destinations/#{destination_id}" @@ -132,8 +132,8 @@ def get_destination(destination_id, rate_limit: 1.0) # refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). # # @note This operation can make a static sandbox call. - # @param [String] destination_id The identifier for the destination that you want to delete. - # @param [Float] rate_limit Requests per second + # @param destination_id [String] The identifier for the destination that you want to delete. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def delete_destination(destination_id, rate_limit: 1.0) path = "/notifications/v1/destinations/#{destination_id}" diff --git a/lib/peddler/api/orders_v0.rb b/lib/peddler/api/orders_v0.rb index 9320be12..5bfc19cc 100644 --- a/lib/peddler/api/orders_v0.rb +++ b/lib/peddler/api/orders_v0.rb @@ -23,29 +23,29 @@ class OrdersV0 < API # in your request; it only impacts the pagination for the filtered orders response. # # @note This operation can make a static sandbox call. - # @param [String] created_after Use this date to select orders created after (or at) a specified time. Only orders + # @param created_after [String] Use this date to select orders created after (or at) a specified time. Only orders # placed after the specified time are returned. The date must be in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` # parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and # `LastUpdatedBefore` cannot be set when `CreatedAfter` is set. - # @param [String] created_before Use this date to select orders created before (or at) a specified time. Only + # @param created_before [String] Use this date to select orders created before (or at) a specified time. Only # orders placed before the specified time are returned. The date must be in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional # when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date # and at least two minutes before current time. - # @param [String] last_updated_after Use this date to select orders that were last updated after (or at) a + # @param last_updated_after [String] Use this date to select orders that were last updated after (or at) a # specified time. An update is defined as any change in order status, including the creation of a new order. # Includes updates made by Amazon and by the seller. The date must be in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` # parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or # `CreatedBefore` cannot be set when `LastUpdatedAfter` is set. - # @param [String] last_updated_before Use this date to select orders that were last updated before (or at) a + # @param last_updated_before [String] Use this date to select orders that were last updated before (or at) a # specified time. An update is defined as any change in order status, including the creation of a new order. # Includes updates made by Amazon and by the seller. The date must be in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is # optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the # `LastUpdatedAfter` date and at least two minutes before current time. - # @param [Array] order_statuses A list of `OrderStatus` values used to filter the results. **Possible + # @param order_statuses [Array] A list of `OrderStatus` values used to filter the results. **Possible # values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, # payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order # has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order @@ -54,23 +54,23 @@ class OrdersV0 < API # `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to # Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - # `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.) - # @param [Array] marketplace_ids A list of `MarketplaceId` values. Used to select orders that were placed + # @param marketplace_ids [Array] A list of `MarketplaceId` values. Used to select orders that were placed # in the specified marketplaces. Refer to [Marketplace # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` # values. - # @param [Array] fulfillment_channels A list that indicates how an order was fulfilled. Filters the + # @param fulfillment_channels [Array] A list that indicates how an order was fulfilled. Filters the # results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller). - # @param [Array] payment_methods A list of payment method values. Use this field to select orders that + # @param payment_methods [Array] A list of payment method values. Use this field to select orders that # were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` # (convenience store), `Other` (Any payment method other than COD or CVS). - # @param [String] buyer_email The email address of a buyer. Used to select orders that contain the specified email + # @param buyer_email [String] The email address of a buyer. Used to select orders that contain the specified email # address. - # @param [String] seller_order_id An order identifier that is specified by the seller. Used to select only the + # @param seller_order_id [String] An order identifier that is specified by the seller. Used to select only the # orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, # `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified. - # @param [Integer] max_results_per_page A number that indicates the maximum number of orders that can be returned + # @param max_results_per_page [Integer] A number that indicates the maximum number of orders that can be returned # per page. Value must be 1 - 100. Default 100. - # @param [Array] easy_ship_shipment_statuses A list of `EasyShipShipmentStatus` values. Used to select + # @param easy_ship_shipment_statuses [Array] A list of `EasyShipShipmentStatus` values. Used to select # Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only # Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the # schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - @@ -83,33 +83,33 @@ class OrdersV0 < API # seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The # package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged # by the carrier.) - # @param [Array] electronic_invoice_statuses A list of `ElectronicInvoiceStatus` values. Used to select + # @param electronic_invoice_statuses [Array] A list of `ElectronicInvoiceStatus` values. Used to select # orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` # (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not # submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - # `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last # submitted electronic invoice was submitted and accepted.) - # @param [String] next_token A string token returned in the response of your previous request. - # @param [Array] amazon_order_ids A list of `AmazonOrderId` values. An `AmazonOrderId` is an + # @param next_token [String] A string token returned in the response of your previous request. + # @param amazon_order_ids [Array] A list of `AmazonOrderId` values. An `AmazonOrderId` is an # Amazon-defined order identifier, in 3-7-7 format. - # @param [String] actual_fulfillment_supply_source_id The `sourceId` of the location from where you want the order + # @param actual_fulfillment_supply_source_id [String] The `sourceId` of the location from where you want the order # fulfilled. - # @param [Boolean] is_ispu When true, this order is marked to be picked up from a store rather than delivered. - # @param [String] store_chain_store_id The store chain store identifier. Linked to a specific store in a store + # @param is_ispu [Boolean] When true, this order is marked to be picked up from a store rather than delivered. + # @param store_chain_store_id [String] The store chain store identifier. Linked to a specific store in a store # chain. - # @param [String] earliest_delivery_date_before Use this date to select orders with a earliest delivery date + # @param earliest_delivery_date_before [String] Use this date to select orders with a earliest delivery date # before (or at) a specified time. The date must be in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] earliest_delivery_date_after Use this date to select orders with a earliest delivery date after + # @param earliest_delivery_date_after [String] Use this date to select orders with a earliest delivery date after # (or at) a specified time. The date must be in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] latest_delivery_date_before Use this date to select orders with a latest delivery date before + # @param latest_delivery_date_before [String] Use this date to select orders with a latest delivery date before # (or at) a specified time. The date must be in [ISO # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] latest_delivery_date_after Use this date to select orders with a latest delivery date after (or + # @param latest_delivery_date_after [String] Use this date to select orders with a latest delivery date after (or # at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) # format. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_orders(marketplace_ids, created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil, order_statuses: nil, fulfillment_channels: nil, payment_methods: nil, @@ -118,7 +118,6 @@ def get_orders(marketplace_ids, created_after: nil, created_before: nil, last_up actual_fulfillment_supply_source_id: nil, is_ispu: nil, store_chain_store_id: nil, earliest_delivery_date_before: nil, earliest_delivery_date_after: nil, latest_delivery_date_before: nil, latest_delivery_date_after: nil, rate_limit: 0.0167) - path = "/orders/v0/orders" params = { "CreatedAfter" => created_after, @@ -151,8 +150,8 @@ def get_orders(marketplace_ids, created_after: nil, created_before: nil, last_up # Returns the order that you specify. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order(order_id, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}" @@ -163,8 +162,8 @@ def get_order(order_id, rate_limit: 0.5) # Returns buyer information for the order that you specify. # # @note This operation can make a static sandbox call. - # @param [String] order_id An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_buyer_info(order_id, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}/buyerInfo" @@ -175,8 +174,8 @@ def get_order_buyer_info(order_id, rate_limit: 0.5) # Returns the shipping address for the order that you specify. # # @note This operation can make a static sandbox call. - # @param [String] order_id An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An `orderId` is an Amazon-defined order identifier, in 3-7-7 format. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_address(order_id, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}/address" @@ -187,8 +186,8 @@ def get_order_address(order_id, rate_limit: 0.5) # Returns the fulfillment instructions for the order that you specify. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_fulfillment_instructions(order_id, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}/fulfillmentInstructions" @@ -205,9 +204,9 @@ def get_order_fulfillment_instructions(order_id, rate_limit: 0.5) # charges, gift status and promotions for the order items in the order. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [String] next_token A string token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param next_token [String] A string token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_items(order_id, next_token: nil, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}/orderItems" @@ -221,9 +220,9 @@ def get_order_items(order_id, next_token: nil, rate_limit: 0.5) # Returns buyer information for the order items in the order that you specify. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [String] next_token A string token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param next_token [String] A string token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_items_buyer_info(order_id, next_token: nil, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}/orderItems/buyerInfo" @@ -237,9 +236,9 @@ def get_order_items_buyer_info(order_id, next_token: nil, rate_limit: 0.5) # Update the shipment status for an order that you specify. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [Hash] payload The request body for the `updateShipmentStatus` operation. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param payload [Hash] The request body for the `updateShipmentStatus` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_shipment_status(order_id, payload, rate_limit: 5.0) path = "/orders/v0/orders/#{order_id}/shipment" @@ -251,8 +250,8 @@ def update_shipment_status(order_id, payload, rate_limit: 5.0) # Returns regulated information for the order that you specify. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_regulated_info(order_id, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}/regulatedInfo" @@ -263,9 +262,9 @@ def get_order_regulated_info(order_id, rate_limit: 0.5) # Updates (approves or rejects) the verification status of an order containing regulated products. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [Hash] payload The request body for the `updateVerificationStatus` operation. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param payload [Hash] The request body for the `updateVerificationStatus` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_verification_status(order_id, payload, rate_limit: 0.5) path = "/orders/v0/orders/#{order_id}/regulatedInfo" @@ -277,9 +276,9 @@ def update_verification_status(order_id, payload, rate_limit: 0.5) # Updates the shipment confirmation status for a specified order. # # @note This operation can make a static sandbox call. - # @param [String] order_id An Amazon-defined order identifier, in 3-7-7 format. - # @param [Hash] payload Request body of `confirmShipment`. - # @param [Float] rate_limit Requests per second + # @param order_id [String] An Amazon-defined order identifier, in 3-7-7 format. + # @param payload [Hash] Request body of `confirmShipment`. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def confirm_shipment(order_id, payload, rate_limit: 2.0) path = "/orders/v0/orders/#{order_id}/shipmentConfirmation" diff --git a/lib/peddler/api/product_fees_v0.rb b/lib/peddler/api/product_fees_v0.rb index 247daa1a..a8e3a219 100644 --- a/lib/peddler/api/product_fees_v0.rb +++ b/lib/peddler/api/product_fees_v0.rb @@ -16,25 +16,23 @@ class API # then account for those fees in your pricing. class ProductFeesV0 < API # Returns the estimated fees for the item indicated by the specified seller SKU in the marketplace specified in - # the request body. - # @note The parameters associated with this operation may contain special characters that require URL encoding to - # call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). You can call `getMyFeesEstimateForSKU` - # for an item on behalf of a selling partner before the selling partner sets the item's price. The selling - # partner can then take any estimated fees into account. Each fees estimate request must include an original - # identifier. This identifier is included in the fees estimate so that you can correlate a fees estimate with - # the original request. - # @note This identifier value is used to identify an estimate. Actual costs may vary. Search "fees" in [Seller - # Central](https://sellercentral.amazon.com/) and consult the store-specific fee schedule for the most - # up-to-date information. - # @note When sellers use the `getMyFeesEstimateForSKU` operation with their `SellerSKU`, they get accurate fees - # based on real item measurements, but only after they've sent their items to Amazon. + # the request body. **Note:** The parameters associated with this operation may contain special characters that + # require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to [URL + # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). You can call `getMyFeesEstimateForSKU` + # for an item on behalf of a selling partner before the selling partner sets the item's price. The selling partner + # can then take any estimated fees into account. Each fees estimate request must include an original identifier. + # This identifier is included in the fees estimate so that you can correlate a fees estimate with the original + # request. **Note:** This identifier value is used to identify an estimate. Actual costs may vary. Search "fees" + # in [Seller Central](https://sellercentral.amazon.com/) and consult the store-specific fee schedule for the most + # up-to-date information. **Note:** When sellers use the `getMyFeesEstimateForSKU` operation with their + # `SellerSKU`, they get accurate fees based on real item measurements, but only after they've sent their items to + # Amazon. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [String] seller_sku Used to identify an item in the given marketplace. SellerSKU is qualified by the + # @param body [Hash] + # @param seller_sku [String] Used to identify an item in the given marketplace. SellerSKU is qualified by the # seller's SellerId, which is included with every operation that you submit. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_my_fees_estimate_for_sku(body, seller_sku, rate_limit: 1.0) path = "/products/fees/v0/listings/#{seller_sku}/feesEstimate" @@ -46,18 +44,16 @@ def get_my_fees_estimate_for_sku(body, seller_sku, rate_limit: 1.0) # request body. You can call `getMyFeesEstimateForASIN` for an item on behalf of a selling partner before the # selling partner sets the item's price. The selling partner can then take estimated fees into account. Each fees # request must include an original identifier. This identifier is included in the fees estimate so you can - # correlate a fees estimate with the original request. - # @note This identifier value is used to identify an estimate. Actual costs may vary. Search "fees" in [Seller - # Central](https://sellercentral.amazon.com/) and consult the store-specific fee schedule for the most - # up-to-date information. - # @note When using the `getMyFeesEstimateForASIN` operation with an ASIN, the fee estimates might be different. - # This is because these estimates use the item's catalog size, which might not always match the actual size of - # the item sent to Amazon. + # correlate a fees estimate with the original request. **Note:** This identifier value is used to identify an + # estimate. Actual costs may vary. Search "fees" in [Seller Central](https://sellercentral.amazon.com/) and + # consult the store-specific fee schedule for the most up-to-date information. **Note:** When using the + # `getMyFeesEstimateForASIN` operation with an ASIN, the fee estimates might be different. This is because these + # estimates use the item's catalog size, which might not always match the actual size of the item sent to Amazon. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item. - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_my_fees_estimate_for_asin(body, asin, rate_limit: 1.0) path = "/products/fees/v0/items/#{asin}/feesEstimate" @@ -68,8 +64,8 @@ def get_my_fees_estimate_for_asin(body, asin, rate_limit: 1.0) # Returns the estimated fees for a list of products. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_my_fees_estimates(body, rate_limit: 0.5) path = "/products/fees/v0/feesEstimate" diff --git a/lib/peddler/api/product_pricing_2022_05_01.rb b/lib/peddler/api/product_pricing_2022_05_01.rb index 85f18c27..b021dc95 100644 --- a/lib/peddler/api/product_pricing_2022_05_01.rb +++ b/lib/peddler/api/product_pricing_2022_05_01.rb @@ -24,13 +24,12 @@ class ProductPricing20220501 < API # specific customer. The response to an unsuccessful request includes the available error text. # # @note This operation can make a static sandbox call. - # @param [Hash] get_featured_offer_expected_price_batch_request_body The batch of `getFeaturedOfferExpectedPrice` + # @param get_featured_offer_expected_price_batch_request_body [Hash] The batch of `getFeaturedOfferExpectedPrice` # requests. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_featured_offer_expected_price_batch(get_featured_offer_expected_price_batch_request_body, rate_limit: 0.033) - path = "/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice" body = get_featured_offer_expected_price_batch_request_body @@ -41,8 +40,8 @@ def get_featured_offer_expected_price_batch(get_featured_offer_expected_price_ba # combination. # # @note This operation can make a static sandbox call. - # @param [Hash] requests The batch of `getCompetitiveSummary` requests. - # @param [Float] rate_limit Requests per second + # @param requests [Hash] The batch of `getCompetitiveSummary` requests. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_competitive_summary(requests, rate_limit: 0.033) path = "/batches/products/pricing/2022-05-01/items/competitiveSummary" diff --git a/lib/peddler/api/product_pricing_v0.rb b/lib/peddler/api/product_pricing_v0.rb index 0fa3abd7..759fd96b 100644 --- a/lib/peddler/api/product_pricing_v0.rb +++ b/lib/peddler/api/product_pricing_v0.rb @@ -15,31 +15,30 @@ class API # The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for # Amazon Marketplace products. class ProductPricingV0 < API - # Returns pricing information for a seller's offer listings based on seller SKU or ASIN. - # @note The parameters associated with this operation may contain special characters that require URL encoding to - # call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Returns pricing information for a seller's offer listings based on seller SKU or ASIN. **Note:** The parameters + # associated with this operation may contain special characters that require URL encoding to call the API. To + # avoid errors with SKUs when encoding URLs, refer to [URL + # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are # returned. - # @param [Array] asins A list of up to twenty Amazon Standard Identification Number (ASIN) values used to + # @param asins [Array] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to # identify items in the given marketplace. - # @param [Array] skus A list of up to twenty seller SKU values used to identify items in the given + # @param skus [Array] A list of up to twenty seller SKU values used to identify items in the given # marketplace. - # @param [String] item_type Indicates whether ASIN values or seller SKU values are used to identify items. If you + # @param item_type [String] Indicates whether ASIN values or seller SKU values are used to identify items. If you # specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins # parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you # provide in the Skus parameter. - # @param [String] item_condition Filters the offer listings based on item condition. Possible values: New, Used, + # @param item_condition [String] Filters the offer listings based on item condition. Possible values: New, Used, # Collectible, Refurbished, Club. - # @param [String] offer_type Indicates whether to request pricing information for the seller's B2C or B2B offers. + # @param offer_type [String] Indicates whether to request pricing information for the seller's B2C or B2B offers. # Default is B2C. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_pricing(marketplace_id, item_type, asins: nil, skus: nil, item_condition: nil, offer_type: nil, rate_limit: 0.5) - path = "/products/pricing/v0/price" params = { "MarketplaceId" => marketplace_id, @@ -53,29 +52,27 @@ def get_pricing(marketplace_id, item_type, asins: nil, skus: nil, item_condition meter(rate_limit).get(path, params:) end - # Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. - # @note The parameters associated with this operation may contain special characters that require URL encoding to - # call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. **Note:** The + # parameters associated with this operation may contain special characters that require URL encoding to call the + # API. To avoid errors with SKUs when encoding URLs, refer to [URL + # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are # returned. - # @param [Array] asins A list of up to twenty Amazon Standard Identification Number (ASIN) values used to + # @param asins [Array] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to # identify items in the given marketplace. - # @param [Array] skus A list of up to twenty seller SKU values used to identify items in the given + # @param skus [Array] A list of up to twenty seller SKU values used to identify items in the given # marketplace. - # @param [String] item_type Indicates whether ASIN values or seller SKU values are used to identify items. If you + # @param item_type [String] Indicates whether ASIN values or seller SKU values are used to identify items. If you # specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins # parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you # provide in the Skus parameter. Possible values: Asin, Sku. - # @param [String] customer_type Indicates whether to request pricing information from the point of view of + # @param customer_type [String] Indicates whether to request pricing information from the point of view of # Consumer or Business buyers. Default is Consumer. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response - def get_competitive_pricing(marketplace_id, item_type, asins: nil, skus: nil, customer_type: nil, - rate_limit: 0.5) - + def get_competitive_pricing(marketplace_id, item_type, asins: nil, skus: nil, customer_type: nil, rate_limit: 0.5) path = "/products/pricing/v0/competitivePrice" params = { "MarketplaceId" => marketplace_id, @@ -88,20 +85,19 @@ def get_competitive_pricing(marketplace_id, item_type, asins: nil, skus: nil, cu meter(rate_limit).get(path, params:) end - # Returns the lowest priced offers for a single SKU listing. - # @note The parameters associated with this operation may contain special characters that require URL encoding to - # call the API. To avoid errors with SKUs when encoding URLs, refer to [URL - # Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). + # Returns the lowest priced offers for a single SKU listing. **Note:** The parameters associated with this + # operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs + # when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are # returned. - # @param [String] item_condition Filters the offer listings based on item condition. Possible values: New, Used, + # @param item_condition [String] Filters the offer listings based on item condition. Possible values: New, Used, # Collectible, Refurbished, Club. - # @param [String] seller_sku Identifies an item in the given marketplace. SellerSKU is qualified by the seller's + # @param seller_sku [String] Identifies an item in the given marketplace. SellerSKU is qualified by the seller's # SellerId, which is included with every operation that you submit. - # @param [String] customer_type Indicates whether to request Consumer or Business offers. Default is Consumer. - # @param [Float] rate_limit Requests per second + # @param customer_type [String] Indicates whether to request Consumer or Business offers. Default is Consumer. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_listing_offers(marketplace_id, item_condition, seller_sku, customer_type: nil, rate_limit: 1.0) path = "/products/pricing/v0/listings/#{seller_sku}/offers" @@ -117,13 +113,13 @@ def get_listing_offers(marketplace_id, item_condition, seller_sku, customer_type # Returns the lowest priced offers for a single item based on ASIN. # # @note This operation can make a static sandbox call. - # @param [String] marketplace_id A marketplace identifier. Specifies the marketplace for which prices are + # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which prices are # returned. - # @param [String] item_condition Filters the offer listings to be considered based on item condition. Possible + # @param item_condition [String] Filters the offer listings to be considered based on item condition. Possible # values: New, Used, Collectible, Refurbished, Club. - # @param [String] asin The Amazon Standard Identification Number (ASIN) of the item. - # @param [String] customer_type Indicates whether to request Consumer or Business offers. Default is Consumer. - # @param [Float] rate_limit Requests per second + # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item. + # @param customer_type [String] Indicates whether to request Consumer or Business offers. Default is Consumer. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_item_offers(marketplace_id, item_condition, asin, customer_type: nil, rate_limit: 0.5) path = "/products/pricing/v0/items/#{asin}/offers" @@ -139,8 +135,8 @@ def get_item_offers(marketplace_id, item_condition, asin, customer_type: nil, ra # Returns the lowest priced offers for a batch of items based on ASIN. # # @note This operation can make a static sandbox call. - # @param [Hash] get_item_offers_batch_request_body - # @param [Float] rate_limit Requests per second + # @param get_item_offers_batch_request_body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_item_offers_batch(get_item_offers_batch_request_body, rate_limit: 0.1) path = "/batches/products/pricing/v0/itemOffers" @@ -152,8 +148,8 @@ def get_item_offers_batch(get_item_offers_batch_request_body, rate_limit: 0.1) # Returns the lowest priced offers for a batch of listings by SKU. # # @note This operation can make a static sandbox call. - # @param [Hash] get_listing_offers_batch_request_body - # @param [Float] rate_limit Requests per second + # @param get_listing_offers_batch_request_body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_listing_offers_batch(get_listing_offers_batch_request_body, rate_limit: 0.5) path = "/batches/products/pricing/v0/listingOffers" diff --git a/lib/peddler/api/product_type_definitions_2020_09_01.rb b/lib/peddler/api/product_type_definitions_2020_09_01.rb index 0d194615..531cf066 100644 --- a/lib/peddler/api/product_type_definitions_2020_09_01.rb +++ b/lib/peddler/api/product_type_definitions_2020_09_01.rb @@ -16,26 +16,25 @@ class API # requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type # that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the # Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For - # more information, see the [Product Type Definitions API Use Case - # Guide](https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide). + # more information, see the {Product Type Definitions API Use Case Guide + # https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide}. class ProductTypeDefinitions20200901 < API # Search for and return a list of Amazon product types that have definitions available. # # @note This operation can make a static sandbox call. - # @param [Array] keywords A comma-delimited list of keywords to search product types. **Note:** Cannot be + # @param keywords [Array] A comma-delimited list of keywords to search product types. **Note:** Cannot be # used with `itemName`. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. - # @param [String] item_name The title of the ASIN to get the product type recommendation. **Note:** Cannot be used + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. + # @param item_name [String] The title of the ASIN to get the product type recommendation. **Note:** Cannot be used # with `keywords`. - # @param [String] locale The locale for the display names in the response. Defaults to the primary locale of the + # @param locale [String] The locale for the display names in the response. Defaults to the primary locale of the # marketplace. - # @param [String] search_locale The locale used for the `keywords` and `itemName` parameters. Defaults to the + # @param search_locale [String] The locale used for the `keywords` and `itemName` parameters. Defaults to the # primary locale of the marketplace. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def search_definitions_product_types(marketplace_ids, keywords: nil, item_name: nil, locale: nil, search_locale: nil, rate_limit: 5.0) - path = "/definitions/2020-09-01/productTypes" params = { "keywords" => keywords, @@ -51,26 +50,25 @@ def search_definitions_product_types(marketplace_ids, keywords: nil, item_name: # Retrieve an Amazon product type definition. # # @note This operation can make a static sandbox call. - # @param [String] product_type The Amazon product type name. - # @param [String] seller_id A selling partner identifier. When provided, seller-specific requirements and values + # @param product_type [String] The Amazon product type name. + # @param seller_id [String] A selling partner identifier. When provided, seller-specific requirements and values # are populated within the product type definition schema, such as brand names associated with the selling # partner. - # @param [Array] marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request. + # @param marketplace_ids [Array] A comma-delimited list of Amazon marketplace identifiers for the request. # Note: This parameter is limited to one marketplaceId at this time. - # @param [String] product_type_version The version of the Amazon product type to retrieve. Defaults to "LATEST",. + # @param product_type_version [String] The version of the Amazon product type to retrieve. Defaults to "LATEST",. # Prerelease versions of product type definitions may be retrieved with "RELEASE_CANDIDATE". If no prerelease # version is currently available, the "LATEST" live version will be provided. - # @param [String] requirements The name of the requirements set to retrieve requirements for. - # @param [String] requirements_enforced Identifies if the required attributes for a requirements set are enforced + # @param requirements [String] The name of the requirements set to retrieve requirements for. + # @param requirements_enforced [String] Identifies if the required attributes for a requirements set are enforced # by the product type definition schema. Non-enforced requirements enable structural validation of individual # attributes without all the required attributes being present (such as for partial updates). - # @param [String] locale Locale for retrieving display labels and other presentation details. Defaults to the + # @param locale [String] Locale for retrieving display labels and other presentation details. Defaults to the # default language of the first marketplace in the request. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_definitions_product_type(product_type, marketplace_ids, seller_id: nil, product_type_version: "LATEST", requirements: "LISTING", requirements_enforced: "ENFORCED", locale: "DEFAULT", rate_limit: 5.0) - path = "/definitions/2020-09-01/productTypes/#{product_type}" params = { "sellerId" => seller_id, diff --git a/lib/peddler/api/replenishment_2022_11_07.rb b/lib/peddler/api/replenishment_2022_11_07.rb index 1a8872d7..fc8ef231 100644 --- a/lib/peddler/api/replenishment_2022_11_07.rb +++ b/lib/peddler/api/replenishment_2022_11_07.rb @@ -20,8 +20,8 @@ class Replenishment20221107 < API # Returns aggregated replenishment program metrics for a selling partner. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request body for the `getSellingPartnerMetrics` operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body for the `getSellingPartnerMetrics` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_selling_partner_metrics(body: nil, rate_limit: 1.0) path = "/replenishment/2022-11-07/sellingPartners/metrics/search" @@ -32,8 +32,8 @@ def get_selling_partner_metrics(body: nil, rate_limit: 1.0) # Returns aggregated replenishment program metrics for a selling partner's offers. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request body for the `listOfferMetrics` operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body for the `listOfferMetrics` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_offer_metrics(body: nil, rate_limit: 1.0) path = "/replenishment/2022-11-07/offers/metrics/search" @@ -44,8 +44,8 @@ def list_offer_metrics(body: nil, rate_limit: 1.0) # Returns the details of a selling partner's replenishment program offers. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request body for the `listOffers` operation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body for the `listOffers` operation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def list_offers(body: nil, rate_limit: 1.0) path = "/replenishment/2022-11-07/offers/search" diff --git a/lib/peddler/api/reports_2021_06_30.rb b/lib/peddler/api/reports_2021_06_30.rb index 66539c42..80385ca9 100644 --- a/lib/peddler/api/reports_2021_06_30.rb +++ b/lib/peddler/api/reports_2021_06_30.rb @@ -18,28 +18,27 @@ class Reports20210630 < API # Returns report details for the reports that match the filters that you specify. # # @note This operation can make a static sandbox call. - # @param [Array] report_types A list of report types used to filter reports. Refer to [Report Type + # @param report_types [Array] A list of report types used to filter reports. Refer to [Report Type # Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When # reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, # createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. - # @param [Array] processing_statuses A list of processing statuses used to filter reports. - # @param [Array] marketplace_ids A list of marketplace identifiers used to filter reports. The reports + # @param processing_statuses [Array] A list of processing statuses used to filter reports. + # @param marketplace_ids [Array] A list of marketplace identifiers used to filter reports. The reports # returned will match at least one of the marketplaces that you specify. - # @param [Integer] page_size The maximum number of reports to return in a single call. - # @param [String] created_since The earliest report creation date and time for reports to include in the response, - # in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. The default is 90 days + # @param page_size [Integer] The maximum number of reports to return in a single call. + # @param created_since [String] The earliest report creation date and time for reports to include in the response, + # in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date time format. The default is 90 days # ago. Reports are retained for a maximum of 90 days. - # @param [String] created_until The latest report creation date and time for reports to include in the response, - # in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. The default is now. - # @param [String] next_token A string token returned in the response to your previous request. `nextToken` is + # @param created_until [String] The latest report creation date and time for reports to include in the response, + # in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date time format. The default is now. + # @param next_token [String] 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 `getReports` operation and include this token as the only parameter. Specifying `nextToken` with any # other parameters will cause the request to fail. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: nil, page_size: 10, created_since: nil, created_until: nil, next_token: nil, rate_limit: 0.0222) - path = "/reports/2021-06-30/reports" params = { "reportTypes" => report_types, @@ -57,8 +56,8 @@ def get_reports(report_types: nil, processing_statuses: nil, marketplace_ids: ni # Creates a report. # # @note This operation can make a static sandbox call. - # @param [Hash] body Information required to create the report. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Information required to create the report. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_report(body, rate_limit: 0.0167) path = "/reports/2021-06-30/reports" @@ -70,9 +69,9 @@ def create_report(body, rate_limit: 0.0167) # reports are returned in subsequent calls to the `getReport` and `getReports` operations. # # @note This operation can make a static sandbox call. - # @param [String] report_id The identifier for the report. This identifier is unique only in combination with a + # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a # seller ID. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_report(report_id, rate_limit: 0.0222) path = "/reports/2021-06-30/reports/#{report_id}" @@ -83,9 +82,9 @@ def cancel_report(report_id, rate_limit: 0.0222) # Returns report details (including the `reportDocumentId`, if available) for the report that you specify. # # @note This operation can make a static sandbox call. - # @param [String] report_id The identifier for the report. This identifier is unique only in combination with a + # @param report_id [String] The identifier for the report. This identifier is unique only in combination with a # seller ID. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_report(report_id, rate_limit: 2.0) path = "/reports/2021-06-30/reports/#{report_id}" @@ -96,9 +95,9 @@ def get_report(report_id, rate_limit: 2.0) # Returns report schedule details that match the filters that you specify. # # @note This operation can make a static sandbox call. - # @param [Array] report_types A list of report types used to filter report schedules. Refer to [Report + # @param report_types [Array] A list of report types used to filter report schedules. Refer to [Report # Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_report_schedules(report_types, rate_limit: 0.0222) path = "/reports/2021-06-30/schedules" @@ -113,8 +112,8 @@ def get_report_schedules(report_types, rate_limit: 0.0222) # will be cancelled and replaced with this one. # # @note This operation can make a static sandbox call. - # @param [Hash] body Information required to create the report schedule. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Information required to create the report schedule. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_report_schedule(body, rate_limit: 0.0222) path = "/reports/2021-06-30/schedules" @@ -125,9 +124,9 @@ def create_report_schedule(body, rate_limit: 0.0222) # Cancels the report schedule that you specify. # # @note This operation can make a static sandbox call. - # @param [String] report_schedule_id The identifier for the report schedule. This identifier is unique only in + # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in # combination with a seller ID. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_report_schedule(report_schedule_id, rate_limit: 0.0222) path = "/reports/2021-06-30/schedules/#{report_schedule_id}" @@ -138,9 +137,9 @@ def cancel_report_schedule(report_schedule_id, rate_limit: 0.0222) # Returns report schedule details for the report schedule that you specify. # # @note This operation can make a static sandbox call. - # @param [String] report_schedule_id The identifier for the report schedule. This identifier is unique only in + # @param report_schedule_id [String] The identifier for the report schedule. This identifier is unique only in # combination with a seller ID. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_report_schedule(report_schedule_id, rate_limit: 0.0222) path = "/reports/2021-06-30/schedules/#{report_schedule_id}" @@ -151,8 +150,8 @@ def get_report_schedule(report_schedule_id, rate_limit: 0.0222) # Returns the information required for retrieving a report document's contents. # # @note This operation can make a static sandbox call. - # @param [String] report_document_id The identifier for the report document. - # @param [Float] rate_limit Requests per second + # @param report_document_id [String] The identifier for the report document. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_report_document(report_document_id, rate_limit: 0.0167) path = "/reports/2021-06-30/documents/#{report_document_id}" diff --git a/lib/peddler/api/sales_v1.rb b/lib/peddler/api/sales_v1.rb index 5fd47deb..f0917c41 100644 --- a/lib/peddler/api/sales_v1.rb +++ b/lib/peddler/api/sales_v1.rb @@ -17,47 +17,46 @@ class SalesV1 < API # Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type. # # @note This operation can make a static sandbox call. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. For example, ATVPDKIKX0DER indicates the US # marketplace. - # @param [String] interval A time interval used for selecting order metrics. This takes the form of two dates + # @param interval [String] A time interval used for selecting order metrics. This takes the form of two dates # separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and # must represent absolute time (either Z notation or offset notation). Example: # 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the # -07:00 zone. - # @param [String] granularity_time_zone An IANA-compatible time zone for determining the day boundary. Required + # @param granularity_time_zone [String] An IANA-compatible time zone for determining the day boundary. Required # when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the # offset of the specified interval value. For example, if the interval value uses Z notation, then # granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an # IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting # for daylight time savings, for US/Pacific zone. - # @param [String] granularity The granularity of the grouping of order metrics, based on a unit of time. + # @param granularity [String] The granularity of the grouping of order metrics, based on a unit of time. # Specifying granularity=Hour results in a successful request only if the interval specified is less than or # equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 # years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire # interval that you specify. If the interval start and end date don’t align with the specified granularity, the # head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of # the request interval, where the day boundary is defined by the granularityTimeZone. - # @param [String] buyer_type Filters the results by the buyer type that you specify, B2B (business to business) or + # @param buyer_type [String] Filters the results by the buyer type that you specify, B2B (business to business) or # B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B # buyers. - # @param [String] fulfillment_network Filters the results by the fulfillment network that you specify, MFN + # @param fulfillment_network [String] Filters the results by the fulfillment network that you specify, MFN # (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the # response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to # include order metrics for only Amazon fulfillment network. - # @param [String] first_day_of_week Specifies the day that the week starts on when granularity=Week, either Monday + # @param first_day_of_week [String] Specifies the day that the week starts on when granularity=Week, either Monday # or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday. - # @param [String] asin Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an + # @param asin [String] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an # error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: # B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN. - # @param [String] sku Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an + # @param sku [String] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an # error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: # TestSKU, if you want the response to include order metrics for only SKU TestSKU. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_metrics(marketplace_ids, interval, granularity, granularity_time_zone: nil, buyer_type: "All", fulfillment_network: nil, first_day_of_week: "Monday", asin: nil, sku: nil, rate_limit: 0.5) - path = "/sales/v1/orderMetrics" params = { "marketplaceIds" => marketplace_ids, diff --git a/lib/peddler/api/sellers_v1.rb b/lib/peddler/api/sellers_v1.rb index 6651edd4..9d8a09c8 100644 --- a/lib/peddler/api/sellers_v1.rb +++ b/lib/peddler/api/sellers_v1.rb @@ -22,7 +22,7 @@ class SellersV1 < API # in those marketplaces. # # @note This operation can make a static sandbox call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_marketplace_participations(rate_limit: 0.016) path = "/sellers/v1/marketplaceParticipations" @@ -33,7 +33,7 @@ def get_marketplace_participations(rate_limit: 0.016) # Returns information about a seller account and its marketplaces. # # @note This operation can make a static sandbox call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_account(rate_limit: 0.016) path = "/sellers/v1/account" diff --git a/lib/peddler/api/services_v1.rb b/lib/peddler/api/services_v1.rb index 811b6722..59ec358e 100644 --- a/lib/peddler/api/services_v1.rb +++ b/lib/peddler/api/services_v1.rb @@ -18,8 +18,8 @@ class ServicesV1 < API # Gets details of service job indicated by the provided `serviceJobID`. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id A service job identifier. - # @param [Float] rate_limit Requests per second + # @param service_job_id [String] A service job identifier. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_service_job_by_service_job_id(service_job_id, rate_limit: 20.0) path = "/service/v1/serviceJobs/#{service_job_id}" @@ -30,10 +30,10 @@ def get_service_job_by_service_job_id(service_job_id, rate_limit: 20.0) # Cancels the service job indicated by the service job identifier specified. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id An Amazon defined service job identifier. - # @param [String] cancellation_reason_code A cancel reason code that specifies the reason for cancelling a service + # @param service_job_id [String] An Amazon defined service job identifier. + # @param cancellation_reason_code [String] A cancel reason code that specifies the reason for cancelling a service # job. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_service_job_by_service_job_id(service_job_id, cancellation_reason_code, rate_limit: 5.0) path = "/service/v1/serviceJobs/#{service_job_id}/cancellations" @@ -47,8 +47,8 @@ def cancel_service_job_by_service_job_id(service_job_id, cancellation_reason_cod # Completes the service job indicated by the service job identifier specified. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id An Amazon defined service job identifier. - # @param [Float] rate_limit Requests per second + # @param service_job_id [String] An Amazon defined service job identifier. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def complete_service_job_by_service_job_id(service_job_id, rate_limit: 5.0) path = "/service/v1/serviceJobs/#{service_job_id}/completions" @@ -59,43 +59,42 @@ def complete_service_job_by_service_job_id(service_job_id, rate_limit: 5.0) # Gets service job details for the specified filter query. # # @note This operation can make a static sandbox call. - # @param [Array] service_order_ids List of service order ids for the query you want to perform.Max values + # @param service_order_ids [Array] List of service order ids for the query you want to perform.Max values # supported 20. - # @param [Array] service_job_status A list of one or more job status by which to filter the list of jobs. - # @param [String] page_token String returned in the response of your previous request. - # @param [Integer] page_size A non-negative integer that indicates the maximum number of jobs to return in the + # @param service_job_status [Array] A list of one or more job status by which to filter the list of jobs. + # @param page_token [String] String returned in the response of your previous request. + # @param page_size [Integer] A non-negative integer that indicates the maximum number of jobs to return in the # list, Value must be 1 - 20. Default 20. - # @param [String] sort_field Sort fields on which you want to sort the output. - # @param [String] sort_order Sort order for the query you want to perform. - # @param [String] created_after A date used for selecting jobs created at or after a specified time. Must be in + # @param sort_field [String] Sort fields on which you want to sort the output. + # @param sort_order [String] Sort order for the query you want to perform. + # @param created_after [String] A date used for selecting jobs created at or after a specified time. Must be in # ISO 8601 format. Required if `LastUpdatedAfter` is not specified. Specifying both `CreatedAfter` and # `LastUpdatedAfter` returns an error. - # @param [String] created_before A date used for selecting jobs created at or before a specified time. Must be in + # @param created_before [String] A date used for selecting jobs created at or before a specified time. Must be in # ISO 8601 format. - # @param [String] last_updated_after A date used for selecting jobs updated at or after a specified time. Must be + # @param last_updated_after [String] A date used for selecting jobs updated at or after a specified time. Must be # in ISO 8601 format. Required if `createdAfter` is not specified. Specifying both `CreatedAfter` and # `LastUpdatedAfter` returns an error. - # @param [String] last_updated_before A date used for selecting jobs updated at or before a specified time. Must + # @param last_updated_before [String] A date used for selecting jobs updated at or before a specified time. Must # be in ISO 8601 format. - # @param [String] schedule_start_date A date used for filtering jobs schedules at or after a specified time. Must + # @param schedule_start_date [String] A date used for filtering jobs schedules at or after a specified time. Must # be in ISO 8601 format. Schedule end date should not be earlier than schedule start date. - # @param [String] schedule_end_date A date used for filtering jobs schedules at or before a specified time. Must + # @param schedule_end_date [String] A date used for filtering jobs schedules at or before a specified time. Must # be in ISO 8601 format. Schedule end date should not be earlier than schedule start date. - # @param [Array] marketplace_ids Used to select jobs that were placed in the specified marketplaces. - # @param [Array] asins List of Amazon Standard Identification Numbers (ASIN) of the items. Max values + # @param marketplace_ids [Array] Used to select jobs that were placed in the specified marketplaces. + # @param asins [Array] List of Amazon Standard Identification Numbers (ASIN) of the items. Max values # supported is 20. - # @param [Array] required_skills A defined set of related knowledge, skills, experience, tools, materials, + # @param required_skills [Array] A defined set of related knowledge, skills, experience, tools, materials, # and work processes common to service delivery for a set of products and/or service scenarios. Max values # supported is 20. - # @param [Array] store_ids List of Amazon-defined identifiers for the region scope. Max values supported + # @param store_ids [Array] List of Amazon-defined identifiers for the region scope. Max values supported # is 50. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_service_jobs(marketplace_ids, service_order_ids: nil, service_job_status: nil, page_token: nil, page_size: 20, sort_field: nil, sort_order: nil, created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil, schedule_start_date: nil, schedule_end_date: nil, asins: nil, required_skills: nil, store_ids: nil, rate_limit: 10.0) - path = "/service/v1/serviceJobs" params = { "serviceOrderIds" => service_order_ids, @@ -122,9 +121,9 @@ def get_service_jobs(marketplace_ids, service_order_ids: nil, service_job_status # Adds an appointment to the service job indicated by the service job identifier specified. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id An Amazon defined service job identifier. - # @param [Hash] body Add appointment operation input details. - # @param [Float] rate_limit Requests per second + # @param service_job_id [String] An Amazon defined service job identifier. + # @param body [Hash] Add appointment operation input details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def add_appointment_for_service_job_by_service_job_id(service_job_id, body, rate_limit: 5.0) path = "/service/v1/serviceJobs/#{service_job_id}/appointments" @@ -135,14 +134,13 @@ def add_appointment_for_service_job_by_service_job_id(service_job_id, body, rate # Reschedules an appointment for the service job indicated by the service job identifier specified. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id An Amazon defined service job identifier. - # @param [String] appointment_id An existing appointment identifier for the Service Job. - # @param [Hash] body Reschedule appointment operation input details. - # @param [Float] rate_limit Requests per second + # @param service_job_id [String] An Amazon defined service job identifier. + # @param appointment_id [String] An existing appointment identifier for the Service Job. + # @param body [Hash] Reschedule appointment operation input details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def reschedule_appointment_for_service_job_by_service_job_id(service_job_id, appointment_id, body, rate_limit: 5.0) - path = "/service/v1/serviceJobs/#{service_job_id}/appointments/#{appointment_id}" meter(rate_limit).post(path, body:) @@ -151,11 +149,11 @@ def reschedule_appointment_for_service_job_by_service_job_id(service_job_id, app # Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id An Amazon-defined service job identifier. Get this value by calling the + # @param service_job_id [String] An Amazon-defined service job identifier. Get this value by calling the # `getServiceJobs` operation of the Services API. - # @param [String] appointment_id An Amazon-defined identifier of active service job appointment. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param appointment_id [String] An Amazon-defined identifier of active service job appointment. + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def assign_appointment_resources(service_job_id, appointment_id, body, rate_limit: 1.0) path = "/service/v1/serviceJobs/#{service_job_id}/appointments/#{appointment_id}/resources" @@ -166,11 +164,11 @@ def assign_appointment_resources(service_job_id, appointment_id, body, rate_limi # Updates the appointment fulfillment data related to a given `jobID` and `appointmentID`. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id An Amazon-defined service job identifier. Get this value by calling the + # @param service_job_id [String] An Amazon-defined service job identifier. Get this value by calling the # `getServiceJobs` operation of the Services API. - # @param [String] appointment_id An Amazon-defined identifier of active service job appointment. - # @param [Hash] body Appointment fulfillment data collection details. - # @param [Float] rate_limit Requests per second + # @param appointment_id [String] An Amazon-defined identifier of active service job appointment. + # @param body [Hash] Appointment fulfillment data collection details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def set_appointment_fulfillment_data(service_job_id, appointment_id, body, rate_limit: 5.0) path = "/service/v1/serviceJobs/#{service_job_id}/appointments/#{appointment_id}/fulfillment" @@ -181,11 +179,11 @@ def set_appointment_fulfillment_data(service_job_id, appointment_id, body, rate_ # Provides capacity slots in a format similar to availability records. # # @note This operation can make a static sandbox call. - # @param [String] resource_id Resource Identifier. - # @param [Hash] body Request body. - # @param [Array] marketplace_ids An identifier for the marketplace in which the resource operates. - # @param [String] next_page_token Next page token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param resource_id [String] Resource Identifier. + # @param body [Hash] Request body. + # @param marketplace_ids [Array] An identifier for the marketplace in which the resource operates. + # @param next_page_token [String] Next page token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_range_slot_capacity(resource_id, body, marketplace_ids, next_page_token: nil, rate_limit: 5.0) path = "/service/v1/serviceResources/#{resource_id}/capacity/range" @@ -200,11 +198,11 @@ def get_range_slot_capacity(resource_id, body, marketplace_ids, next_page_token: # Provides capacity in fixed-size slots. # # @note This operation can make a static sandbox call. - # @param [String] resource_id Resource Identifier. - # @param [Hash] body Request body. - # @param [Array] marketplace_ids An identifier for the marketplace in which the resource operates. - # @param [String] next_page_token Next page token returned in the response of your previous request. - # @param [Float] rate_limit Requests per second + # @param resource_id [String] Resource Identifier. + # @param body [Hash] Request body. + # @param marketplace_ids [Array] An identifier for the marketplace in which the resource operates. + # @param next_page_token [String] Next page token returned in the response of your previous request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_fixed_slot_capacity(resource_id, body, marketplace_ids, next_page_token: nil, rate_limit: 5.0) path = "/service/v1/serviceResources/#{resource_id}/capacity/fixed" @@ -219,10 +217,10 @@ def get_fixed_slot_capacity(resource_id, body, marketplace_ids, next_page_token: # Update the schedule of the given resource. # # @note This operation can make a static sandbox call. - # @param [String] resource_id Resource (store) Identifier - # @param [Hash] body Schedule details - # @param [Array] marketplace_ids An identifier for the marketplace in which the resource operates. - # @param [Float] rate_limit Requests per second + # @param resource_id [String] Resource (store) Identifier + # @param body [Hash] Schedule details + # @param marketplace_ids [Array] An identifier for the marketplace in which the resource operates. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_schedule(resource_id, body, marketplace_ids, rate_limit: 5.0) path = "/service/v1/serviceResources/#{resource_id}/schedules" @@ -236,9 +234,9 @@ def update_schedule(resource_id, body, marketplace_ids, rate_limit: 5.0) # Create a reservation. # # @note This operation can make a static sandbox call. - # @param [Hash] body Reservation details - # @param [Array] marketplace_ids An identifier for the marketplace in which the resource operates. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Reservation details + # @param marketplace_ids [Array] An identifier for the marketplace in which the resource operates. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_reservation(body, marketplace_ids, rate_limit: 5.0) path = "/service/v1/reservation" @@ -252,10 +250,10 @@ def create_reservation(body, marketplace_ids, rate_limit: 5.0) # Update a reservation. # # @note This operation can make a static sandbox call. - # @param [String] reservation_id Reservation Identifier - # @param [Hash] body Reservation details - # @param [Array] marketplace_ids An identifier for the marketplace in which the resource operates. - # @param [Float] rate_limit Requests per second + # @param reservation_id [String] Reservation Identifier + # @param body [Hash] Reservation details + # @param marketplace_ids [Array] An identifier for the marketplace in which the resource operates. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_reservation(reservation_id, body, marketplace_ids, rate_limit: 5.0) path = "/service/v1/reservation/#{reservation_id}" @@ -269,9 +267,9 @@ def update_reservation(reservation_id, body, marketplace_ids, rate_limit: 5.0) # Cancel a reservation. # # @note This operation can make a static sandbox call. - # @param [String] reservation_id Reservation Identifier - # @param [Array] marketplace_ids An identifier for the marketplace in which the resource operates. - # @param [Float] rate_limit Requests per second + # @param reservation_id [String] Reservation Identifier + # @param marketplace_ids [Array] An identifier for the marketplace in which the resource operates. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_reservation(reservation_id, marketplace_ids, rate_limit: 5.0) path = "/service/v1/reservation/#{reservation_id}" @@ -285,19 +283,18 @@ def cancel_reservation(reservation_id, marketplace_ids, rate_limit: 5.0) # Gets appointment slots for the service associated with the service job id specified. # # @note This operation can make a static sandbox call. - # @param [String] service_job_id A service job identifier to retrive appointment slots for associated service. - # @param [Array] marketplace_ids An identifier for the marketplace in which the resource operates. - # @param [String] start_time A time from which the appointment slots will be retrieved. The specified time must be + # @param service_job_id [String] A service job identifier to retrive appointment slots for associated service. + # @param marketplace_ids [Array] An identifier for the marketplace in which the resource operates. + # @param start_time [String] A time from which the appointment slots will be retrieved. The specified time must be # in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per # business configuration. - # @param [String] end_time A time up to which the appointment slots will be retrieved. The specified time must be + # @param end_time [String] A time up to which the appointment slots will be retrieved. The specified time must be # in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per # business configuration. Maximum range of appointment slots can be 90 days. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_appointmment_slots_by_job_id(service_job_id, marketplace_ids, start_time: nil, end_time: nil, rate_limit: 5.0) - path = "/service/v1/serviceJobs/#{service_job_id}/appointmentSlots" params = { "marketplaceIds" => marketplace_ids, @@ -311,16 +308,16 @@ def get_appointmment_slots_by_job_id(service_job_id, marketplace_ids, start_time # Gets appointment slots as per the service context specified. # # @note This operation can make a static sandbox call. - # @param [String] asin ASIN associated with the service. - # @param [String] store_id Store identifier defining the region scope to retrive appointment slots. - # @param [Array] marketplace_ids An identifier for the marketplace for which appointment slots are queried - # @param [String] start_time A time from which the appointment slots will be retrieved. The specified time must be + # @param asin [String] ASIN associated with the service. + # @param store_id [String] Store identifier defining the region scope to retrive appointment slots. + # @param marketplace_ids [Array] An identifier for the marketplace for which appointment slots are queried + # @param start_time [String] A time from which the appointment slots will be retrieved. The specified time must be # in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per # business configuration. - # @param [String] end_time A time up to which the appointment slots will be retrieved. The specified time must be + # @param end_time [String] A time up to which the appointment slots will be retrieved. The specified time must be # in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per # business configuration. Maximum range of appointment slots can be 90 days. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_appointment_slots(asin, store_id, marketplace_ids, start_time: nil, end_time: nil, rate_limit: 20.0) path = "/service/v1/appointmentSlots" @@ -338,8 +335,8 @@ def get_appointment_slots(asin, store_id, marketplace_ids, start_time: nil, end_ # Creates an upload destination. # # @note This operation can make a static sandbox call. - # @param [Hash] body Upload document operation input details. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Upload document operation input details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_service_document_upload_destination(body, rate_limit: 5.0) path = "/service/v1/documents" diff --git a/lib/peddler/api/shipment_invoicing_v0.rb b/lib/peddler/api/shipment_invoicing_v0.rb index fdcaf535..614769a5 100644 --- a/lib/peddler/api/shipment_invoicing_v0.rb +++ b/lib/peddler/api/shipment_invoicing_v0.rb @@ -18,10 +18,10 @@ class ShipmentInvoicingV0 < API # Returns the shipment details required to issue an invoice for the specified shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus - # notification. For information about subscribing to notifications, see the [Notifications API Use Case - # Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide). - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus + # notification. For information about subscribing to notifications, see the {Notifications API Use Case Guide + # https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide}. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment_details(shipment_id, rate_limit: 1.133) path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}" @@ -32,9 +32,9 @@ def get_shipment_details(shipment_id, rate_limit: 1.133) # Submits a shipment invoice document for a given shipment. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id The identifier for the shipment. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] The identifier for the shipment. + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_invoice(shipment_id, body, rate_limit: 1.133) path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice" @@ -45,8 +45,8 @@ def submit_invoice(shipment_id, body, rate_limit: 1.133) # Returns the invoice status for the shipment you specify. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id The shipment identifier for the shipment. - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] The shipment identifier for the shipment. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_invoice_status(shipment_id, rate_limit: 1.133) path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice/status" diff --git a/lib/peddler/api/shipping_v1.rb b/lib/peddler/api/shipping_v1.rb index c8351a3d..82baecf2 100644 --- a/lib/peddler/api/shipping_v1.rb +++ b/lib/peddler/api/shipping_v1.rb @@ -21,8 +21,8 @@ class ShippingV1 < API # Create a new shipment. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_shipment(body, rate_limit: 5.0) path = "/shipping/v1/shipments" @@ -33,8 +33,8 @@ def create_shipment(body, rate_limit: 5.0) # Return the entire shipment object for the shipmentId. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment(shipment_id, rate_limit: 5.0) path = "/shipping/v1/shipments/#{shipment_id}" @@ -45,8 +45,8 @@ def get_shipment(shipment_id, rate_limit: 5.0) # Cancel a shipment by the given shipmentId. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_shipment(shipment_id, rate_limit: 5.0) path = "/shipping/v1/shipments/#{shipment_id}/cancel" @@ -57,9 +57,9 @@ def cancel_shipment(shipment_id, rate_limit: 5.0) # Purchase shipping labels based on a given rate. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def purchase_labels(shipment_id, body, rate_limit: 5.0) path = "/shipping/v1/shipments/#{shipment_id}/purchaseLabels" @@ -70,10 +70,10 @@ def purchase_labels(shipment_id, body, rate_limit: 5.0) # Retrieve shipping label based on the shipment id and tracking id. # # @note This operation can make a static sandbox call. - # @param [String] shipment_id - # @param [String] tracking_id - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param shipment_id [String] + # @param tracking_id [String] + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def retrieve_shipping_label(shipment_id, tracking_id, body, rate_limit: 5.0) path = "/shipping/v1/shipments/#{shipment_id}/containers/#{tracking_id}/label" @@ -84,8 +84,8 @@ def retrieve_shipping_label(shipment_id, tracking_id, body, rate_limit: 5.0) # Purchase shipping labels. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def purchase_shipment(body, rate_limit: 5.0) path = "/shipping/v1/purchaseShipment" @@ -96,8 +96,8 @@ def purchase_shipment(body, rate_limit: 5.0) # Get service rates. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_rates(body, rate_limit: 5.0) path = "/shipping/v1/rates" @@ -108,7 +108,7 @@ def get_rates(body, rate_limit: 5.0) # Verify if the current account is valid. # # @note This operation can make a static sandbox call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_account(rate_limit: 5.0) path = "/shipping/v1/account" @@ -119,8 +119,8 @@ def get_account(rate_limit: 5.0) # Return the tracking information of a shipment. # # @note This operation can make a static sandbox call. - # @param [String] tracking_id - # @param [Float] rate_limit Requests per second + # @param tracking_id [String] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_tracking_information(tracking_id, rate_limit: 1.0) path = "/shipping/v1/tracking/#{tracking_id}" diff --git a/lib/peddler/api/shipping_v2.rb b/lib/peddler/api/shipping_v2.rb index 5609978a..668d24e3 100644 --- a/lib/peddler/api/shipping_v2.rb +++ b/lib/peddler/api/shipping_v2.rb @@ -19,10 +19,10 @@ class ShippingV2 < API # Returns the available shipping service offerings. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param body [Hash] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_rates(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) path = "/shipping/v2/shipments/rates" @@ -33,15 +33,15 @@ def get_rates(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) # Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related # details and documents. # - # @param [Hash] body - # @param [String] x_amzn_idempotency_key A unique value which the server uses to recognize subsequent retries of + # @param body [Hash] + # @param x_amzn_idempotency_key [String] A unique value which the server uses to recognize subsequent retries of # the same request. - # @param [String] locale The IETF Language Tag. Note that this only supports the primary language subtag with one + # @param locale [String] The IETF Language Tag. Note that this only supports the primary language subtag with one # secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional # designation. This does not support additional subtags beyond the primary and secondary language subtags. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def direct_purchase_shipment(body, x_amzn_idempotency_key: nil, locale: nil, x_amzn_shipping_business_id: nil, rate_limit: 80.0) @@ -58,12 +58,12 @@ def direct_purchase_shipment(body, x_amzn_idempotency_key: nil, locale: nil, x_a # receive this error response, you must get the rates for the shipment again. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body - # @param [String] x_amzn_idempotency_key A unique value which the server uses to recognize subsequent retries of + # @param body [Hash] + # @param x_amzn_idempotency_key [String] A unique value which the server uses to recognize subsequent retries of # the same request. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def purchase_shipment(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil, rate_limit: 80.0) path = "/shipping/v2/shipments" @@ -74,10 +74,10 @@ def purchase_shipment(body, x_amzn_idempotency_key: nil, x_amzn_shipping_busines # Purchases a shipping service identifier and returns purchase-related details and documents. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param body [Hash] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def one_click_shipment(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) path = "/shipping/v2/oneClickShipment" @@ -88,13 +88,13 @@ def one_click_shipment(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) # Returns tracking information for a purchased shipment. # # @note This operation can make a dynamic sandbox call. - # @param [String] tracking_id A carrier-generated tracking identifier originally returned by the purchaseShipment + # @param tracking_id [String] A carrier-generated tracking identifier originally returned by the purchaseShipment # operation. - # @param [String] carrier_id A carrier identifier originally returned by the getRates operation for the selected + # @param carrier_id [String] A carrier identifier originally returned by the getRates operation for the selected # rate. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_tracking(tracking_id, carrier_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0) path = "/shipping/v2/tracking" @@ -109,20 +109,19 @@ def get_tracking(tracking_id, carrier_id, x_amzn_shipping_business_id: nil, rate # Returns the shipping documents associated with a package in a shipment. # # @note This operation can make a dynamic sandbox call. - # @param [String] shipment_id The shipment identifier originally returned by the purchaseShipment operation. - # @param [String] package_client_reference_id The package client reference identifier originally provided in the + # @param shipment_id [String] The shipment identifier originally returned by the purchaseShipment operation. + # @param package_client_reference_id [String] The package client reference identifier originally provided in the # request body parameter for the getRates operation. - # @param [String] format The file format of the document. Must be one of the supported formats returned by the + # @param format [String] The file format of the document. Must be one of the supported formats returned by the # getRates operation. - # @param [Number] dpi The resolution of the document (for example, 300 means 300 dots per inch). Must be one of + # @param dpi [Number] The resolution of the document (for example, 300 means 300 dots per inch). Must be one of # the supported resolutions returned in the response to the getRates operation. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment_documents(shipment_id, package_client_reference_id, format: nil, dpi: nil, x_amzn_shipping_business_id: nil, rate_limit: 80.0) - path = "/shipping/v2/shipments/#{shipment_id}/documents" params = { "packageClientReferenceId" => package_client_reference_id, @@ -136,10 +135,10 @@ def get_shipment_documents(shipment_id, package_client_reference_id, format: nil # Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. # # @note This operation can make a dynamic sandbox call. - # @param [String] shipment_id The shipment identifier originally returned by the purchaseShipment operation. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param shipment_id [String] The shipment identifier originally returned by the purchaseShipment operation. + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def cancel_shipment(shipment_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0) path = "/shipping/v2/shipments/#{shipment_id}/cancel" @@ -152,12 +151,12 @@ def cancel_shipment(shipment_id, x_amzn_shipping_business_id: nil, rate_limit: 8 # additional inputs are required for the rate (shipping offering) that you want to purchase. # # @note This operation can make a static sandbox call. - # @param [String] request_token The request token returned in the response to the getRates operation. - # @param [String] rate_id The rate identifier for the shipping offering (rate) returned in the response to the + # @param request_token [String] The request token returned in the response to the getRates operation. + # @param rate_id [String] The rate identifier for the shipping offering (rate) returned in the response to the # getRates operation. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_additional_inputs(request_token, rate_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0) path = "/shipping/v2/shipments/additionalInputs/schema" @@ -171,9 +170,9 @@ def get_additional_inputs(request_token, rate_id, x_amzn_shipping_business_id: n # This API will return a list of input schema required to register a shipper account with the carrier. # - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_carrier_account_form_inputs(x_amzn_shipping_business_id: nil, rate_limit: 80.0) cannot_sandbox! @@ -185,10 +184,10 @@ def get_carrier_account_form_inputs(x_amzn_shipping_business_id: nil, rate_limit # This API will return Get all carrier accounts for a merchant. # - # @param [Hash] body - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param body [Hash] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_carrier_accounts(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) cannot_sandbox! @@ -200,11 +199,11 @@ def get_carrier_accounts(body, x_amzn_shipping_business_id: nil, rate_limit: 80. # This API associates/links the specified carrier account with the merchant. # - # @param [String] carrier_id The unique identifier associated with the carrier account. - # @param [Hash] body - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param carrier_id [String] The unique identifier associated with the carrier account. + # @param body [Hash] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def link_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) cannot_sandbox! @@ -216,11 +215,11 @@ def link_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, rat # This API Unlink the specified carrier account with the merchant. # - # @param [String] carrier_id carrier Id to unlink with merchant. - # @param [Hash] body - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param carrier_id [String] carrier Id to unlink with merchant. + # @param body [Hash] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def unlink_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) cannot_sandbox! @@ -232,12 +231,12 @@ def unlink_carrier_account(carrier_id, body, x_amzn_shipping_business_id: nil, r # This API Call to generate the collection form. # - # @param [Hash] body - # @param [String] x_amzn_idempotency_key A unique value which the server uses to recognize subsequent retries of + # @param body [Hash] + # @param x_amzn_idempotency_key [String] A unique value which the server uses to recognize subsequent retries of # the same request. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_collection_form(body, x_amzn_idempotency_key: nil, x_amzn_shipping_business_id: nil, rate_limit: 80.0) @@ -250,10 +249,10 @@ def generate_collection_form(body, x_amzn_idempotency_key: nil, x_amzn_shipping_ # This API Call to get the history of the previously generated collection forms. # - # @param [Hash] body - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param body [Hash] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_collection_form_history(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) cannot_sandbox! @@ -266,10 +265,10 @@ def get_collection_form_history(body, x_amzn_shipping_business_id: nil, rate_lim # This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments # with an eligible carrier for manifesting shall be returned. # - # @param [Hash] body - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param body [Hash] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_unmanifested_shipments(body, x_amzn_shipping_business_id: nil, rate_limit: 80.0) cannot_sandbox! @@ -281,10 +280,10 @@ def get_unmanifested_shipments(body, x_amzn_shipping_business_id: nil, rate_limi # This API reprint a collection form. # - # @param [String] collection_form_id collection form Id to reprint a collection. - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param collection_form_id [String] collection form Id to reprint a collection. + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_collection_form(collection_form_id, x_amzn_shipping_business_id: nil, rate_limit: 80.0) cannot_sandbox! @@ -297,16 +296,15 @@ def get_collection_form(collection_form_id, x_amzn_shipping_business_id: nil, ra # Returns a list of access points in proximity of input postal code. # # @note This operation can make a dynamic sandbox call. - # @param [Array] access_point_types - # @param [String] country_code - # @param [String] postal_code - # @param [String] x_amzn_shipping_business_id Amazon shipping business to assume for this request. The default is + # @param access_point_types [Array] + # @param country_code [String] + # @param postal_code [String] + # @param x_amzn_shipping_business_id [String] Amazon shipping business to assume for this request. The default is # AmazonShipping_UK. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_access_points(access_point_types, country_code, postal_code, x_amzn_shipping_business_id: nil, rate_limit: 80.0) - path = "/shipping/v2/accessPoints" params = { "accessPointTypes" => access_point_types, diff --git a/lib/peddler/api/solicitations_v1.rb b/lib/peddler/api/solicitations_v1.rb index fbd5164c..6f3c5f11 100644 --- a/lib/peddler/api/solicitations_v1.rb +++ b/lib/peddler/api/solicitations_v1.rb @@ -25,11 +25,11 @@ class SolicitationsV1 < API # productReviewAndSellerFeedbackSolicitation solicitation type is available. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which you want a list + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which you want a list # of available solicitation types. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_solicitation_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0) path = "/solicitations/v1/orders/#{amazon_order_id}" @@ -44,11 +44,11 @@ def get_solicitation_actions_for_order(amazon_order_id, marketplace_ids, rate_li # only one productReviewAndSellerFeedback or free form proactive message per order. # # @note This operation can make a static sandbox call. - # @param [String] amazon_order_id An Amazon order identifier. This specifies the order for which a solicitation is + # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a solicitation is # sent. - # @param [Array] marketplace_ids A marketplace identifier. This specifies the marketplace in which the + # @param marketplace_ids [Array] A marketplace identifier. This specifies the marketplace in which the # order was placed. Only one marketplace can be specified. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids, rate_limit: 1.0) path = "/solicitations/v1/orders/#{amazon_order_id}/solicitations/productReviewAndSellerFeedback" diff --git a/lib/peddler/api/supply_sources_2020_07_01.rb b/lib/peddler/api/supply_sources_2020_07_01.rb index fe6a9ccf..f421ea1a 100644 --- a/lib/peddler/api/supply_sources_2020_07_01.rb +++ b/lib/peddler/api/supply_sources_2020_07_01.rb @@ -17,9 +17,9 @@ class SupplySources20200701 < API # The path to retrieve paginated supply sources. # # @note This operation can make a static sandbox call. - # @param [String] next_page_token The pagination token to retrieve a specific page of results. - # @param [Number] page_size The number of supply sources to return per paginated request. - # @param [Float] rate_limit Requests per second + # @param next_page_token [String] The pagination token to retrieve a specific page of results. + # @param page_size [Number] The number of supply sources to return per paginated request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_supply_sources(next_page_token: nil, page_size: 10, rate_limit: nil) path = "/supplySources/2020-07-01/supplySources" @@ -34,8 +34,8 @@ def get_supply_sources(next_page_token: nil, page_size: 10, rate_limit: nil) # Create a new supply source. # # @note This operation can make a static sandbox call. - # @param [Hash] payload A request to create a supply source. - # @param [Float] rate_limit Requests per second + # @param payload [Hash] A request to create a supply source. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_supply_source(payload, rate_limit: nil) path = "/supplySources/2020-07-01/supplySources" @@ -47,8 +47,8 @@ def create_supply_source(payload, rate_limit: nil) # Retrieve a supply source. # # @note This operation can make a static sandbox call. - # @param [String] supply_source_id The unique identifier of a supply source. - # @param [Float] rate_limit Requests per second + # @param supply_source_id [String] The unique identifier of a supply source. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_supply_source(supply_source_id, rate_limit: nil) path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}" @@ -59,9 +59,9 @@ def get_supply_source(supply_source_id, rate_limit: nil) # Update the configuration and capabilities of a supply source. # # @note This operation can make a static sandbox call. - # @param [String] supply_source_id The unique identitier of a supply source. - # @param [Hash] payload - # @param [Float] rate_limit Requests per second + # @param supply_source_id [String] The unique identitier of a supply source. + # @param payload [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_supply_source(supply_source_id, payload: nil, rate_limit: nil) path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}" @@ -73,8 +73,8 @@ def update_supply_source(supply_source_id, payload: nil, rate_limit: nil) # Archive a supply source, making it inactive. Cannot be undone. # # @note This operation can make a static sandbox call. - # @param [String] supply_source_id The unique identifier of a supply source. - # @param [Float] rate_limit Requests per second + # @param supply_source_id [String] The unique identifier of a supply source. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def archive_supply_source(supply_source_id, rate_limit: nil) path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}" @@ -85,9 +85,9 @@ def archive_supply_source(supply_source_id, rate_limit: nil) # Update the status of a supply source. # # @note This operation can make a static sandbox call. - # @param [String] supply_source_id The unique identifier of a supply source. - # @param [Hash] payload - # @param [Float] rate_limit Requests per second + # @param supply_source_id [String] The unique identifier of a supply source. + # @param payload [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def update_supply_source_status(supply_source_id, payload: nil, rate_limit: nil) path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}/status" diff --git a/lib/peddler/api/tokens_2021_03_01.rb b/lib/peddler/api/tokens_2021_03_01.rb index 85188bce..5fd31d81 100644 --- a/lib/peddler/api/tokens_2021_03_01.rb +++ b/lib/peddler/api/tokens_2021_03_01.rb @@ -15,8 +15,8 @@ class API # The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable # Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted # resources that you specify. The RDT authorizes subsequent calls to restricted operations that correspond to the - # restricted resources that you specified. For more information, see the [Tokens API Use Case - # Guide](https://developer-docs.amazon.com/sp-api/docs/tokens-api-use-case-guide). + # restricted resources that you specified. For more information, see the {Tokens API Use Case Guide + # https://developer-docs.amazon.com/sp-api/docs/tokens-api-use-case-guide}. class Tokens20210301 < API # Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted # resource is the HTTP method and path from a restricted operation that returns Personally Identifiable @@ -25,8 +25,8 @@ class Tokens20210301 < API # calls to the corresponding restricted operations. # # @note This operation can make a static sandbox call. - # @param [Hash] body The restricted data token request details. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The restricted data token request details. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_restricted_data_token(body, rate_limit: 1.0) path = "/tokens/2021-03-01/restrictedDataToken" diff --git a/lib/peddler/api/uploads_2020_11_01.rb b/lib/peddler/api/uploads_2020_11_01.rb index d3c29e0a..e2d45adc 100644 --- a/lib/peddler/api/uploads_2020_11_01.rb +++ b/lib/peddler/api/uploads_2020_11_01.rb @@ -18,19 +18,19 @@ class Uploads20201101 < API # Creates an upload destination, returning the information required to upload a file to the destination and to # programmatically access the file. # - # @param [Array] marketplace_ids A list of marketplace identifiers. This specifies the marketplaces where + # @param marketplace_ids [Array] A list of marketplace identifiers. This specifies the marketplaces where # the upload will be available. Only one marketplace can be specified. - # @param [String] content_md5 An MD5 hash of the content to be submitted to the upload destination. This value is + # @param content_md5 [String] An MD5 hash of the content to be submitted to the upload destination. This value is # used to determine if the data has been corrupted or tampered with during transit. - # @param [String] resource The resource for the upload destination that you are creating. For example, if you are + # @param resource [String] The resource for the upload destination that you are creating. For example, if you are # creating an upload destination for the createLegalDisclosure operation of the Messaging API, the `{resource}` # would be `/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure`, and the entire path would be # `/uploads/2020-11-01/uploadDestinations/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure`. If you # are creating an upload destination for an Aplus content document, the `{resource}` would be # `aplus/2020-11-01/contentDocuments` and the path would be # `/uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments`. - # @param [String] content_type The content type of the file to be uploaded. - # @param [Float] rate_limit Requests per second + # @param content_type [String] The content type of the file to be uploaded. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_upload_destination_for_resource(marketplace_ids, content_md5, resource, content_type: nil, rate_limit: 10.0) diff --git a/lib/peddler/api/vendor_direct_fulfillment_inventory_v1.rb b/lib/peddler/api/vendor_direct_fulfillment_inventory_v1.rb index 65bcad66..0feb2ea6 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_inventory_v1.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_inventory_v1.rb @@ -18,9 +18,9 @@ class VendorDirectFulfillmentInventoryV1 < API # Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request body that contains the inventory update data to submit. - # @param [String] warehouse_id Identifier for the warehouse for which to update inventory. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body that contains the inventory update data to submit. + # @param warehouse_id [String] Identifier for the warehouse for which to update inventory. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_inventory_update(body, warehouse_id, rate_limit: 10.0) path = "/vendor/directFulfillment/inventory/v1/warehouses/#{warehouse_id}/items" diff --git a/lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb b/lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb index 966c5177..4f5a1d44 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb @@ -22,25 +22,24 @@ class VendorDirectFulfillmentOrders20211228 < API # order. # # @note This operation can make a dynamic sandbox call. - # @param [String] ship_from_party_id The vendor warehouse identifier for the fulfillment warehouse. If not + # @param ship_from_party_id [String] The vendor warehouse identifier for the fulfillment warehouse. If not # specified, the result will contain orders for all warehouses. - # @param [String] status Returns only the purchase orders that match the specified status. If not specified, the + # @param status [String] Returns only the purchase orders that match the specified status. If not specified, the # result will contain orders that match any status. - # @param [Integer] limit The limit to the number of purchase orders returned. - # @param [String] created_after Purchase orders that became available after this date and time will be included in + # @param limit [Integer] The limit to the number of purchase orders returned. + # @param created_after [String] Purchase orders that became available after this date and time will be included in # the result. Must be in ISO-8601 date/time format. - # @param [String] created_before Purchase orders that became available before this date and time will be included + # @param created_before [String] Purchase orders that became available before this date and time will be included # in the result. Must be in ISO-8601 date/time format. - # @param [String] sort_order Sort the list in ascending or descending order by order creation date. - # @param [String] next_token Used for pagination when there are more orders than the specified result size limit. + # @param sort_order [String] Sort the list in ascending or descending order by order creation date. + # @param next_token [String] Used for pagination when there are more orders than the specified result size limit. # The token value is returned in the previous API call. - # @param [String] include_details When true, returns the complete purchase order details. Otherwise, only purchase + # @param include_details [String] When true, returns the complete purchase order details. Otherwise, only purchase # order numbers are returned. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil, next_token: nil, include_details: "true", rate_limit: 10.0) - path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders" params = { "shipFromPartyId" => ship_from_party_id, @@ -59,9 +58,9 @@ def get_orders(created_after, created_before, ship_from_party_id: nil, status: n # Returns purchase order information for the purchaseOrderNumber that you specify. # # @note This operation can make a dynamic sandbox call. - # @param [String] purchase_order_number The order identifier for the purchase order that you want. Formatting + # @param purchase_order_number [String] The order identifier for the purchase order that you want. Formatting # Notes: alpha-numeric code. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders/#{purchase_order_number}" @@ -72,8 +71,8 @@ def get_order(purchase_order_number, rate_limit: 10.0) # Submits acknowledgements for one or more purchase orders. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body The request body containing the acknowledgement to an order - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body containing the acknowledgement to an order + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_acknowledgement(body, rate_limit: 10.0) path = "/vendor/directFulfillment/orders/2021-12-28/acknowledgements" diff --git a/lib/peddler/api/vendor_direct_fulfillment_orders_v1.rb b/lib/peddler/api/vendor_direct_fulfillment_orders_v1.rb index f640aafe..46f81ec8 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_orders_v1.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_orders_v1.rb @@ -22,25 +22,24 @@ class VendorDirectFulfillmentOrdersV1 < API # order. # # @note This operation can make a static sandbox call. - # @param [String] ship_from_party_id The vendor warehouse identifier for the fulfillment warehouse. If not + # @param ship_from_party_id [String] The vendor warehouse identifier for the fulfillment warehouse. If not # specified, the result will contain orders for all warehouses. - # @param [String] status Returns only the purchase orders that match the specified status. If not specified, the + # @param status [String] Returns only the purchase orders that match the specified status. If not specified, the # result will contain orders that match any status. - # @param [Integer] limit The limit to the number of purchase orders returned. - # @param [String] created_after Purchase orders that became available after this date and time will be included in + # @param limit [Integer] The limit to the number of purchase orders returned. + # @param created_after [String] Purchase orders that became available after this date and time will be included in # the result. Must be in ISO-8601 date/time format. - # @param [String] created_before Purchase orders that became available before this date and time will be included + # @param created_before [String] Purchase orders that became available before this date and time will be included # in the result. Must be in ISO-8601 date/time format. - # @param [String] sort_order Sort the list in ascending or descending order by order creation date. - # @param [String] next_token Used for pagination when there are more orders than the specified result size limit. + # @param sort_order [String] Sort the list in ascending or descending order by order creation date. + # @param next_token [String] Used for pagination when there are more orders than the specified result size limit. # The token value is returned in the previous API call. - # @param [String] include_details When true, returns the complete purchase order details. Otherwise, only purchase + # @param include_details [String] When true, returns the complete purchase order details. Otherwise, only purchase # order numbers are returned. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil, next_token: nil, include_details: "true", rate_limit: 10.0) - path = "/vendor/directFulfillment/orders/v1/purchaseOrders" params = { "shipFromPartyId" => ship_from_party_id, @@ -59,9 +58,9 @@ def get_orders(created_after, created_before, ship_from_party_id: nil, status: n # Returns purchase order information for the purchaseOrderNumber that you specify. # # @note This operation can make a static sandbox call. - # @param [String] purchase_order_number The order identifier for the purchase order that you want. Formatting + # @param purchase_order_number [String] The order identifier for the purchase order that you want. Formatting # Notes: alpha-numeric code. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/orders/v1/purchaseOrders/#{purchase_order_number}" @@ -72,8 +71,8 @@ def get_order(purchase_order_number, rate_limit: 10.0) # Submits acknowledgements for one or more purchase orders. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request body that contains the order acknowledgement. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body that contains the order acknowledgement. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_acknowledgement(body, rate_limit: 10.0) path = "/vendor/directFulfillment/orders/v1/acknowledgements" diff --git a/lib/peddler/api/vendor_direct_fulfillment_payments_v1.rb b/lib/peddler/api/vendor_direct_fulfillment_payments_v1.rb index d6a0bb92..0d0dbd23 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_payments_v1.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_payments_v1.rb @@ -18,8 +18,8 @@ class VendorDirectFulfillmentPaymentsV1 < API # Submits one or more invoices for a vendor's direct fulfillment orders. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request body that contains one or more invoices for vendor orders. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body that contains one or more invoices for vendor orders. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_invoice(body, rate_limit: 10.0) path = "/vendor/directFulfillment/payments/v1/invoices" diff --git a/lib/peddler/api/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb b/lib/peddler/api/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb index 77b34177..dd8b86e5 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb @@ -18,8 +18,8 @@ class VendorDirectFulfillmentSandboxTestData20211028 < API # Submits a request to generate test order data for Vendor Direct Fulfillment API entities. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body The request payload that contain parameters to generate test order data scenarios. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request payload that contain parameters to generate test order data scenarios. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def generate_order_scenarios(body, rate_limit: nil) path = "/vendor/directFulfillment/sandbox/2021-10-28/orders" @@ -31,9 +31,9 @@ def generate_order_scenarios(body, rate_limit: nil) # order data if the transaction is successful. # # @note This operation can make a dynamic sandbox call. - # @param [String] transaction_id The transaction identifier returned in the response for the + # @param transaction_id [String] The transaction identifier returned in the response for the # `generateOrderScenarios` operation. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_order_scenarios(transaction_id, rate_limit: nil) path = "/vendor/directFulfillment/sandbox/2021-10-28/transactions/#{transaction_id}" diff --git a/lib/peddler/api/vendor_direct_fulfillment_shipping_2021_12_28.rb b/lib/peddler/api/vendor_direct_fulfillment_shipping_2021_12_28.rb index a5f03b7a..62f6104a 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_shipping_2021_12_28.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_shipping_2021_12_28.rb @@ -20,21 +20,20 @@ class VendorDirectFulfillmentShipping20211228 < API # search must not be more than 7 days. # # @note This operation can make a dynamic sandbox call. - # @param [String] ship_from_party_id The vendor warehouseId for order fulfillment. If not specified, the result + # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified, the result # will contain orders for all warehouses. - # @param [Integer] limit The limit to the number of records returned. - # @param [String] created_after Shipping labels that became available after this date and time will be included in + # @param limit [Integer] The limit to the number of records returned. + # @param created_after [String] Shipping labels that became available after this date and time will be included in # the result. Must be in ISO-8601 date/time format. - # @param [String] created_before Shipping labels that became available before this date and time will be included + # @param created_before [String] Shipping labels that became available before this date and time will be included # in the result. Must be in ISO-8601 date/time format. - # @param [String] sort_order Sort ASC or DESC by order creation date. - # @param [String] next_token Used for pagination when there are more ship labels than the specified result size + # @param sort_order [String] Sort ASC or DESC by order creation date. + # @param next_token [String] Used for pagination when there are more ship labels than the specified result size # limit. The token value is returned in the previous API call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC", next_token: nil, rate_limit: 10.0) - path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels" params = { "shipFromPartyId" => ship_from_party_id, @@ -51,8 +50,8 @@ def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, # Creates a shipping label for a purchase order and returns a transactionId for reference. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body Request body that contains the shipping labels data. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request body that contains the shipping labels data. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipping_label_request(body, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels" @@ -63,9 +62,9 @@ def submit_shipping_label_request(body, rate_limit: 10.0) # Returns a shipping label for the purchaseOrderNumber that you specify. # # @note This operation can make a dynamic sandbox call. - # @param [String] purchase_order_number The purchase order number for which you want to return the shipping label. + # @param purchase_order_number [String] The purchase order number for which you want to return the shipping label. # Should be the same `purchaseOrderNumber` as received in the order. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipping_label(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/#{purchase_order_number}" @@ -76,10 +75,10 @@ def get_shipping_label(purchase_order_number, rate_limit: 10.0) # Creates shipping labels for a purchase order and returns the labels. # # @note This operation can make a dynamic sandbox call. - # @param [String] purchase_order_number The purchase order number for which you want to return the shipping + # @param purchase_order_number [String] The purchase order number for which you want to return the shipping # labels. It should be the same purchaseOrderNumber as received in the order. - # @param [Hash] body The request payload that contains parameters for creating shipping labels. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request payload that contains parameters for creating shipping labels. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def create_shipping_labels(purchase_order_number, body, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/#{purchase_order_number}" @@ -90,8 +89,8 @@ def create_shipping_labels(purchase_order_number, body, rate_limit: 10.0) # Submits one or more shipment confirmations for vendor orders. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body Request body containing the shipment confirmations data. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request body containing the shipment confirmations data. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipment_confirmations(body, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/2021-12-28/shipmentConfirmations" @@ -104,8 +103,8 @@ def submit_shipment_confirmations(body, rate_limit: 10.0) # order, when the package is outside of Amazon Network visibility. # # @note This operation can make a dynamic sandbox call. - # @param [Hash] body Request body that contains the shipment status update data. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request body that contains the shipment status update data. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipment_status_updates(body, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/2021-12-28/shipmentStatusUpdates" @@ -118,21 +117,20 @@ def submit_shipment_status_updates(body, rate_limit: 10.0) # search must be no more than 7 days. # # @note This operation can make a dynamic sandbox call. - # @param [String] ship_from_party_id The vendor warehouseId for order fulfillment. If not specified, the result + # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified, the result # will contain orders for all warehouses. - # @param [Integer] limit The limit to the number of records returned - # @param [String] created_after Orders that became available after this date and time will be included in the + # @param limit [Integer] The limit to the number of records returned + # @param created_after [String] Orders that became available after this date and time will be included in the # result. Must be in ISO-8601 date/time format. - # @param [String] created_before Orders that became available before this date and time will be included in the + # @param created_before [String] Orders that became available before this date and time will be included in the # result. Must be in ISO-8601 date/time format. - # @param [String] sort_order Sort ASC or DESC by order creation date. - # @param [String] next_token Used for pagination when there are more orders than the specified result size limit. + # @param sort_order [String] Sort ASC or DESC by order creation date. + # @param next_token [String] Used for pagination when there are more orders than the specified result size limit. # The token value is returned in the previous API call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil, next_token: nil, rate_limit: 10.0) - path = "/vendor/directFulfillment/shipping/2021-12-28/customerInvoices" params = { "shipFromPartyId" => ship_from_party_id, @@ -149,8 +147,8 @@ def get_customer_invoices(created_after, created_before, ship_from_party_id: nil # Returns a customer invoice based on the purchaseOrderNumber that you specify. # # @note This operation can make a dynamic sandbox call. - # @param [String] purchase_order_number Purchase order number of the shipment for which to return the invoice. - # @param [Float] rate_limit Requests per second + # @param purchase_order_number [String] Purchase order number of the shipment for which to return the invoice. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_customer_invoice(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/2021-12-28/customerInvoices/#{purchase_order_number}" @@ -162,21 +160,20 @@ def get_customer_invoice(purchase_order_number, rate_limit: 10.0) # must not be more than 7 days. # # @note This operation can make a dynamic sandbox call. - # @param [String] ship_from_party_id The vendor warehouseId for order fulfillment. If not specified the result + # @param ship_from_party_id [String] The vendor warehouseId for order fulfillment. If not specified the result # will contain orders for all warehouses. - # @param [Integer] limit The limit to the number of records returned - # @param [String] created_after Packing slips that became available after this date and time will be included in + # @param limit [Integer] The limit to the number of records returned + # @param created_after [String] Packing slips that became available after this date and time will be included in # the result. Must be in ISO-8601 date/time format. - # @param [String] created_before Packing slips that became available before this date and time will be included in + # @param created_before [String] Packing slips that became available before this date and time will be included in # the result. Must be in ISO-8601 date/time format. - # @param [String] sort_order Sort ASC or DESC by packing slip creation date. - # @param [String] next_token Used for pagination when there are more packing slips than the specified result size + # @param sort_order [String] Sort ASC or DESC by packing slip creation date. + # @param next_token [String] Used for pagination when there are more packing slips than the specified result size # limit. The token value is returned in the previous API call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC", next_token: nil, rate_limit: 10.0) - path = "/vendor/directFulfillment/shipping/2021-12-28/packingSlips" params = { "shipFromPartyId" => ship_from_party_id, @@ -193,8 +190,8 @@ def get_packing_slips(created_after, created_before, ship_from_party_id: nil, li # Returns a packing slip based on the purchaseOrderNumber that you specify. # # @note This operation can make a dynamic sandbox call. - # @param [String] purchase_order_number The purchaseOrderNumber for the packing slip you want. - # @param [Float] rate_limit Requests per second + # @param purchase_order_number [String] The purchaseOrderNumber for the packing slip you want. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_packing_slip(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/2021-12-28/packingSlips/#{purchase_order_number}" diff --git a/lib/peddler/api/vendor_direct_fulfillment_shipping_v1.rb b/lib/peddler/api/vendor_direct_fulfillment_shipping_v1.rb index 642bf901..18234214 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_shipping_v1.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_shipping_v1.rb @@ -20,21 +20,20 @@ class VendorDirectFulfillmentShippingV1 < API # to search must not be more than 7 days. # # @note This operation can make a static sandbox call. - # @param [String] ship_from_party_id The vendor `warehouseId` for order fulfillment. If not specified, the result + # @param ship_from_party_id [String] The vendor `warehouseId` for order fulfillment. If not specified, the result # will contain orders for all warehouses. - # @param [Integer] limit The limit to the number of records returned. - # @param [String] created_after Shipping labels that became available after this date and time will be included in - # the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format. - # @param [String] created_before Shipping labels that became available before this date and time will be included - # in the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format. - # @param [String] sort_order Sort ASC or DESC by order creation date. - # @param [String] next_token Used for pagination when there are more ship labels than the specified result size + # @param limit [Integer] The limit to the number of records returned. + # @param created_after [String] Shipping labels that became available after this date and time will be included in + # the result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date/time format. + # @param created_before [String] Shipping labels that became available before this date and time will be included + # in the result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date/time format. + # @param sort_order [String] Sort ASC or DESC by order creation date. + # @param next_token [String] Used for pagination when there are more ship labels than the specified result size # limit. The token value is returned in the previous API call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC", next_token: nil, rate_limit: 10.0) - path = "/vendor/directFulfillment/shipping/v1/shippingLabels" params = { "shipFromPartyId" => ship_from_party_id, @@ -51,8 +50,8 @@ def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, # Creates a shipping label for a purchase order and returns a `transactionId` for reference. # # @note This operation can make a static sandbox call. - # @param [Hash] body Request body containing one or more shipping labels data. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request body containing one or more shipping labels data. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipping_label_request(body, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/v1/shippingLabels" @@ -63,9 +62,9 @@ def submit_shipping_label_request(body, rate_limit: 10.0) # Returns a shipping label for the `purchaseOrderNumber` that you specify. # # @note This operation can make a static sandbox call. - # @param [String] purchase_order_number The purchase order number for which you want to return the shipping label. + # @param purchase_order_number [String] The purchase order number for which you want to return the shipping label. # It should be the same `purchaseOrderNumber` as received in the order. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipping_label(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/v1/shippingLabels/#{purchase_order_number}" @@ -76,8 +75,8 @@ def get_shipping_label(purchase_order_number, rate_limit: 10.0) # Submits one or more shipment confirmations for vendor orders. # # @note This operation can make a static sandbox call. - # @param [Hash] body Request body containing the shipment confirmations data. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request body containing the shipment confirmations data. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipment_confirmations(body, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/v1/shipmentConfirmations" @@ -90,8 +89,8 @@ def submit_shipment_confirmations(body, rate_limit: 10.0) # order, when the package is outside of Amazon Network visibility. # # @note This operation can make a static sandbox call. - # @param [Hash] body Request body containing the shipment status update data. - # @param [Float] rate_limit Requests per second + # @param body [Hash] Request body containing the shipment status update data. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipment_status_updates(body, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates" @@ -104,21 +103,20 @@ def submit_shipment_status_updates(body, rate_limit: 10.0) # to search must be no more than 7 days. # # @note This operation can make a static sandbox call. - # @param [String] ship_from_party_id The vendor `warehouseId` for order fulfillment. If not specified, the result + # @param ship_from_party_id [String] The vendor `warehouseId` for order fulfillment. If not specified, the result # will contain orders for all warehouses. - # @param [Integer] limit The limit to the number of records returned - # @param [String] created_after Orders that became available after this date and time will be included in the - # result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format. - # @param [String] created_before Orders that became available before this date and time will be included in the - # result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format. - # @param [String] sort_order Sort ASC or DESC by order creation date. - # @param [String] next_token Used for pagination when there are more orders than the specified result size limit. + # @param limit [Integer] The limit to the number of records returned + # @param created_after [String] Orders that became available after this date and time will be included in the + # result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date/time format. + # @param created_before [String] Orders that became available before this date and time will be included in the + # result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date/time format. + # @param sort_order [String] Sort ASC or DESC by order creation date. + # @param next_token [String] Used for pagination when there are more orders than the specified result size limit. # The token value is returned in the previous API call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil, next_token: nil, rate_limit: 10.0) - path = "/vendor/directFulfillment/shipping/v1/customerInvoices" params = { "shipFromPartyId" => ship_from_party_id, @@ -135,8 +133,8 @@ def get_customer_invoices(created_after, created_before, ship_from_party_id: nil # Returns a customer invoice based on the `purchaseOrderNumber` that you specify. # # @note This operation can make a static sandbox call. - # @param [String] purchase_order_number Purchase order number of the shipment for which to return the invoice. - # @param [Float] rate_limit Requests per second + # @param purchase_order_number [String] Purchase order number of the shipment for which to return the invoice. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_customer_invoice(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/v1/customerInvoices/#{purchase_order_number}" @@ -148,21 +146,20 @@ def get_customer_invoice(purchase_order_number, rate_limit: 10.0) # must not be more than 7 days. # # @note This operation can make a static sandbox call. - # @param [String] ship_from_party_id The vendor `warehouseId` for order fulfillment. If not specified the result + # @param ship_from_party_id [String] The vendor `warehouseId` for order fulfillment. If not specified the result # will contain orders for all warehouses. - # @param [Integer] limit The limit to the number of records returned - # @param [String] created_after Packing slips that became available after this date and time will be included in - # the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format. - # @param [String] created_before Packing slips that became available before this date and time will be included in - # the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date/time format. - # @param [String] sort_order Sort ASC or DESC by packing slip creation date. - # @param [String] next_token Used for pagination when there are more packing slips than the specified result size + # @param limit [Integer] The limit to the number of records returned + # @param created_after [String] Packing slips that became available after this date and time will be included in + # the result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date/time format. + # @param created_before [String] Packing slips that became available before this date and time will be included in + # the result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date/time format. + # @param sort_order [String] Sort ASC or DESC by packing slip creation date. + # @param next_token [String] Used for pagination when there are more packing slips than the specified result size # limit. The token value is returned in the previous API call. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC", next_token: nil, rate_limit: 10.0) - path = "/vendor/directFulfillment/shipping/v1/packingSlips" params = { "shipFromPartyId" => ship_from_party_id, @@ -179,8 +176,8 @@ def get_packing_slips(created_after, created_before, ship_from_party_id: nil, li # Returns a packing slip based on the `purchaseOrderNumber` that you specify. # # @note This operation can make a static sandbox call. - # @param [String] purchase_order_number The `purchaseOrderNumber` for the packing slip you want. - # @param [Float] rate_limit Requests per second + # @param purchase_order_number [String] The `purchaseOrderNumber` for the packing slip you want. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_packing_slip(purchase_order_number, rate_limit: 10.0) path = "/vendor/directFulfillment/shipping/v1/packingSlips/#{purchase_order_number}" diff --git a/lib/peddler/api/vendor_direct_fulfillment_transactions_2021_12_28.rb b/lib/peddler/api/vendor_direct_fulfillment_transactions_2021_12_28.rb index 5c7fc851..752ef04e 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_transactions_2021_12_28.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_transactions_2021_12_28.rb @@ -18,9 +18,9 @@ class VendorDirectFulfillmentTransactions20211228 < API # Returns the status of the transaction indicated by the specified `transactionId`. # # @note This operation can make a dynamic sandbox call. - # @param [String] transaction_id Previously returned in the response to the POST request of a specific + # @param transaction_id [String] Previously returned in the response to the POST request of a specific # transaction. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_transaction_status(transaction_id, rate_limit: 10.0) path = "/vendor/directFulfillment/transactions/2021-12-28/transactions/#{transaction_id}" diff --git a/lib/peddler/api/vendor_direct_fulfillment_transactions_v1.rb b/lib/peddler/api/vendor_direct_fulfillment_transactions_v1.rb index 6be43a65..69b62784 100644 --- a/lib/peddler/api/vendor_direct_fulfillment_transactions_v1.rb +++ b/lib/peddler/api/vendor_direct_fulfillment_transactions_v1.rb @@ -18,9 +18,9 @@ class VendorDirectFulfillmentTransactionsV1 < API # Returns the status of the transaction indicated by the specified `transactionId`. # # @note This operation can make a static sandbox call. - # @param [String] transaction_id Previously returned in the response to the POST request of a specific + # @param transaction_id [String] Previously returned in the response to the POST request of a specific # transaction. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_transaction_status(transaction_id, rate_limit: 10.0) path = "/vendor/directFulfillment/transactions/v1/transactions/#{transaction_id}" diff --git a/lib/peddler/api/vendor_invoices_v1.rb b/lib/peddler/api/vendor_invoices_v1.rb index 0652cebf..8e6437a8 100644 --- a/lib/peddler/api/vendor_invoices_v1.rb +++ b/lib/peddler/api/vendor_invoices_v1.rb @@ -17,8 +17,8 @@ class VendorInvoicesV1 < API # Submit new invoices to Amazon. # # @note This operation can make a static sandbox call. - # @param [Hash] body The request body containing the invoice data to submit. - # @param [Float] rate_limit Requests per second + # @param body [Hash] The request body containing the invoice data to submit. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_invoices(body, rate_limit: 10.0) path = "/vendor/payments/v1/invoices" diff --git a/lib/peddler/api/vendor_orders_v1.rb b/lib/peddler/api/vendor_orders_v1.rb index b31e93e4..051c0cbd 100644 --- a/lib/peddler/api/vendor_orders_v1.rb +++ b/lib/peddler/api/vendor_orders_v1.rb @@ -21,37 +21,36 @@ class VendorOrdersV1 < API # purchase order. # # @note This operation can make a static sandbox call. - # @param [Integer] limit The limit to the number of records returned. Default value is 100 records. - # @param [String] created_after Purchase orders that became available after this time will be included in the + # @param limit [Integer] The limit to the number of records returned. Default value is 100 records. + # @param created_after [String] Purchase orders that became available after this time will be included in the # result. Must be in ISO-8601 date/time format. - # @param [String] created_before Purchase orders that became available before this time will be included in the + # @param created_before [String] Purchase orders that became available before this time will be included in the # result. Must be in ISO-8601 date/time format. - # @param [String] sort_order Sort in ascending or descending order by purchase order creation date. - # @param [String] next_token Used for pagination when there is more purchase orders than the specified result size + # @param sort_order [String] Sort in ascending or descending order by purchase order creation date. + # @param next_token [String] Used for pagination when there is more purchase orders than the specified result size # limit. The token value is returned in the previous API call - # @param [String] include_details When true, returns purchase orders with complete details. Otherwise, only + # @param include_details [String] When true, returns purchase orders with complete details. Otherwise, only # purchase order numbers are returned. Default value is true. - # @param [String] changed_after Purchase orders that changed after this timestamp will be included in the result. + # @param changed_after [String] Purchase orders that changed after this timestamp will be included in the result. # Must be in ISO-8601 date/time format. - # @param [String] changed_before Purchase orders that changed before this timestamp will be included in the + # @param changed_before [String] Purchase orders that changed before this timestamp will be included in the # result. Must be in ISO-8601 date/time format. - # @param [String] po_item_state Current state of the purchase order item. If this value is Cancelled, this API + # @param po_item_state [String] Current state of the purchase order item. If this value is Cancelled, this API # will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as # zero. - # @param [String] is_po_changed When true, returns purchase orders which were modified after the order was placed. + # @param is_po_changed [String] When true, returns purchase orders which were modified after the order was placed. # Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the # original one. Default value is false. - # @param [String] purchase_order_state Filters purchase orders based on the purchase order state. - # @param [String] ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This + # @param purchase_order_state [String] Filters purchase orders based on the purchase order state. + # @param ordering_vendor_code [String] Filters purchase orders based on the specified ordering vendor code. This # value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all # purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client # application are returned. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_purchase_orders(limit: nil, created_after: nil, created_before: nil, sort_order: nil, next_token: nil, include_details: nil, changed_after: nil, changed_before: nil, po_item_state: nil, is_po_changed: nil, purchase_order_state: nil, ordering_vendor_code: nil, rate_limit: 10.0) - path = "/vendor/orders/v1/purchaseOrders" params = { "limit" => limit, @@ -74,9 +73,9 @@ def get_purchase_orders(limit: nil, created_after: nil, created_before: nil, sor # Returns a purchase order based on the `purchaseOrderNumber` value that you specify. # # @note This operation can make a static sandbox call. - # @param [String] purchase_order_number The purchase order identifier for the order that you want. Formatting + # @param purchase_order_number [String] The purchase order identifier for the order that you want. Formatting # Notes: 8-character alpha-numeric code. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_purchase_order(purchase_order_number, rate_limit: 10.0) path = "/vendor/orders/v1/purchaseOrders/#{purchase_order_number}" @@ -87,8 +86,8 @@ def get_purchase_order(purchase_order_number, rate_limit: 10.0) # Submits acknowledgements for one or more purchase orders. # # @note This operation can make a static sandbox call. - # @param [Hash] body - # @param [Float] rate_limit Requests per second + # @param body [Hash] + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_acknowledgement(body, rate_limit: 10.0) path = "/vendor/orders/v1/acknowledgements" @@ -101,42 +100,41 @@ def submit_acknowledgement(body, rate_limit: 10.0) # order status by providing the purchase order number. # # @note This operation can make a static sandbox call. - # @param [Integer] limit The limit to the number of records returned. Default value is 100 records. - # @param [String] sort_order Sort in ascending or descending order by purchase order creation date. - # @param [String] next_token Used for pagination when there are more purchase orders than the specified result + # @param limit [Integer] The limit to the number of records returned. Default value is 100 records. + # @param sort_order [String] Sort in ascending or descending order by purchase order creation date. + # @param next_token [String] Used for pagination when there are more purchase orders than the specified result # size limit. - # @param [String] created_after Purchase orders that became available after this timestamp will be included in the + # @param created_after [String] Purchase orders that became available after this timestamp will be included in the # result. Must be in ISO-8601 date/time format. - # @param [String] created_before Purchase orders that became available before this timestamp will be included in + # @param created_before [String] Purchase orders that became available before this timestamp will be included in # the result. Must be in ISO-8601 date/time format. - # @param [String] updated_after Purchase orders for which the last purchase order update happened after this + # @param updated_after [String] Purchase orders for which the last purchase order update happened after this # timestamp will be included in the result. Must be in ISO-8601 date/time format. - # @param [String] updated_before Purchase orders for which the last purchase order update happened before this + # @param updated_before [String] Purchase orders for which the last purchase order update happened before this # timestamp will be included in the result. Must be in ISO-8601 date/time format. - # @param [String] purchase_order_number Provides purchase order status for the specified purchase order number. - # @param [String] purchase_order_status Filters purchase orders based on the specified purchase order status. If + # @param purchase_order_number [String] Provides purchase order status for the specified purchase order number. + # @param purchase_order_status [String] Filters purchase orders based on the specified purchase order status. If # not included in filter, this will return purchase orders for all statuses. - # @param [String] item_confirmation_status Filters purchase orders based on their item confirmation status. If the + # @param item_confirmation_status [String] Filters purchase orders based on their item confirmation status. If the # item confirmation status is not included in the filter, purchase orders for all confirmation statuses are # included. - # @param [String] item_receive_status Filters purchase orders based on the purchase order's item receive status. + # @param item_receive_status [String] Filters purchase orders based on the purchase order's item receive status. # If the item receive status is not included in the filter, purchase orders for all receive statuses are # included. - # @param [String] ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This + # @param ordering_vendor_code [String] Filters purchase orders based on the specified ordering vendor code. This # value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase # orders for all the vendor codes that exist in the vendor group used to authorize API client application are # returned. - # @param [String] ship_to_party_id Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by + # @param ship_to_party_id [String] Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by # providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. # If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor # group purchase orders. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_purchase_orders_status(limit: nil, sort_order: nil, next_token: nil, created_after: nil, created_before: nil, updated_after: nil, updated_before: nil, purchase_order_number: nil, purchase_order_status: nil, item_confirmation_status: nil, item_receive_status: nil, ordering_vendor_code: nil, ship_to_party_id: nil, rate_limit: 10.0) - path = "/vendor/orders/v1/purchaseOrdersStatus" params = { "limit" => limit, diff --git a/lib/peddler/api/vendor_shipments_v1.rb b/lib/peddler/api/vendor_shipments_v1.rb index 6ad419ad..caaed809 100644 --- a/lib/peddler/api/vendor_shipments_v1.rb +++ b/lib/peddler/api/vendor_shipments_v1.rb @@ -18,8 +18,8 @@ class VendorShipmentsV1 < API # Submits one or more shipment confirmations for vendor orders. # # @note This operation can make a static sandbox call. - # @param [Hash] body A request to submit shipment confirmation. - # @param [Float] rate_limit Requests per second + # @param body [Hash] A request to submit shipment confirmation. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipment_confirmations(body, rate_limit: 10.0) path = "/vendor/shipping/v1/shipmentConfirmations" @@ -29,8 +29,8 @@ def submit_shipment_confirmations(body, rate_limit: 10.0) # Submits one or more shipment request for vendor Orders. # - # @param [Hash] body A request to submit shipment request. - # @param [Float] rate_limit Requests per second + # @param body [Hash] A request to submit shipment request. + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def submit_shipments(body, rate_limit: 10.0) cannot_sandbox! @@ -43,50 +43,50 @@ def submit_shipments(body, rate_limit: 10.0) # Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details # related to shipment based on the filter parameters value that you specify. # - # @param [Integer] limit The limit to the number of records returned. Default value is 50 records. - # @param [String] sort_order Sort in ascending or descending order by purchase order creation date. - # @param [String] next_token Used for pagination when there are more shipments than the specified result size + # @param limit [Integer] The limit to the number of records returned. Default value is 50 records. + # @param sort_order [String] Sort in ascending or descending order by purchase order creation date. + # @param next_token [String] Used for pagination when there are more shipments than the specified result size # limit. - # @param [String] created_after Get Shipment Details that became available after this timestamp will be included - # in the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] created_before Get Shipment Details that became available before this timestamp will be included - # in the result. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] shipment_confirmed_before Get Shipment Details by passing Shipment confirmed create Date Before. - # Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] shipment_confirmed_after Get Shipment Details by passing Shipment confirmed create Date After. - # Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] package_label_created_before Get Shipment Details by passing Package label create Date by buyer. - # Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] package_label_created_after Get Shipment Details by passing Package label create Date After by - # buyer. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] shipped_before Get Shipment Details by passing Shipped Date Before. Must be in [ISO - # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] shipped_after Get Shipment Details by passing Shipped Date After. Must be in [ISO - # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] estimated_delivery_before Get Shipment Details by passing Estimated Delivery Date Before. Must - # be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] estimated_delivery_after Get Shipment Details by passing Estimated Delivery Date Before. Must be - # in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] shipment_delivery_before Get Shipment Details by passing Shipment Delivery Date Before. Must be - # in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] shipment_delivery_after Get Shipment Details by passing Shipment Delivery Date After. Must be in - # [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] requested_pick_up_before Get Shipment Details by passing Before Requested pickup date. Must be - # in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] requested_pick_up_after Get Shipment Details by passing After Requested pickup date. Must be in - # [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] scheduled_pick_up_before Get Shipment Details by passing Before scheduled pickup date. Must be - # in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] scheduled_pick_up_after Get Shipment Details by passing After Scheduled pickup date. Must be in - # [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. - # @param [String] current_shipment_status Get Shipment Details by passing Current shipment status. - # @param [String] vendor_shipment_identifier Get Shipment Details by passing Vendor Shipment ID - # @param [String] buyer_reference_number Get Shipment Details by passing buyer Reference ID - # @param [String] buyer_warehouse_code Get Shipping Details based on buyer warehouse code. This value should be + # @param created_after [String] Get Shipment Details that became available after this timestamp will be included + # in the result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param created_before [String] Get Shipment Details that became available before this timestamp will be included + # in the result. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param shipment_confirmed_before [String] Get Shipment Details by passing Shipment confirmed create Date Before. + # Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param shipment_confirmed_after [String] Get Shipment Details by passing Shipment confirmed create Date After. + # Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param package_label_created_before [String] Get Shipment Details by passing Package label create Date by buyer. + # Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param package_label_created_after [String] Get Shipment Details by passing Package label create Date After by + # buyer. Must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param shipped_before [String] Get Shipment Details by passing Shipped Date Before. Must be in {ISO 8601 + # https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param shipped_after [String] Get Shipment Details by passing Shipped Date After. Must be in {ISO 8601 + # https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param estimated_delivery_before [String] Get Shipment Details by passing Estimated Delivery Date Before. Must + # be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param estimated_delivery_after [String] Get Shipment Details by passing Estimated Delivery Date Before. Must be + # in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param shipment_delivery_before [String] Get Shipment Details by passing Shipment Delivery Date Before. Must be + # in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param shipment_delivery_after [String] Get Shipment Details by passing Shipment Delivery Date After. Must be in + # {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param requested_pick_up_before [String] Get Shipment Details by passing Before Requested pickup date. Must be + # in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param requested_pick_up_after [String] Get Shipment Details by passing After Requested pickup date. Must be in + # {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param scheduled_pick_up_before [String] Get Shipment Details by passing Before scheduled pickup date. Must be + # in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param scheduled_pick_up_after [String] Get Shipment Details by passing After Scheduled pickup date. Must be in + # {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format. + # @param current_shipment_status [String] Get Shipment Details by passing Current shipment status. + # @param vendor_shipment_identifier [String] Get Shipment Details by passing Vendor Shipment ID + # @param buyer_reference_number [String] Get Shipment Details by passing buyer Reference ID + # @param buyer_warehouse_code [String] Get Shipping Details based on buyer warehouse code. This value should be # same as 'shipToParty.partyId' in the Shipment. - # @param [String] seller_warehouse_code Get Shipping Details based on vendor warehouse code. This value should be + # @param seller_warehouse_code [String] Get Shipping Details based on vendor warehouse code. This value should be # same as 'sellingParty.partyId' in the Shipment. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_shipment_details(limit: nil, sort_order: nil, next_token: nil, created_after: nil, created_before: nil, shipment_confirmed_before: nil, shipment_confirmed_after: nil, package_label_created_before: nil, diff --git a/lib/peddler/api/vendor_transaction_status_v1.rb b/lib/peddler/api/vendor_transaction_status_v1.rb index ba5af615..9b158d05 100644 --- a/lib/peddler/api/vendor_transaction_status_v1.rb +++ b/lib/peddler/api/vendor_transaction_status_v1.rb @@ -17,9 +17,9 @@ class API class VendorTransactionStatusV1 < API # Returns the status of the transaction that you specify. # - # @param [String] transaction_id The GUID provided by Amazon in the 'transactionId' field in response to the post + # @param transaction_id [String] The GUID provided by Amazon in the 'transactionId' field in response to the post # request of a specific transaction. - # @param [Float] rate_limit Requests per second + # @param rate_limit [Float] Requests per second # @return [Hash] The API response def get_transaction(transaction_id, rate_limit: 10.0) cannot_sandbox!