Merge pull request #22 from mendywoly/catalog-items-2020-12-01

catalog items 2020-12-01

lib/catalog-items-api-model.rb

@@ -1,9 +1,9 @@
 =begin
 #Selling Partner API for Catalog Items
 
-#The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
+#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://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/catalog-items-api-use-case-guide/catalog-items-api-use-case-guide_2020-12-01.md).
 
-OpenAPI spec version: v0
+OpenAPI spec version: 2020-12-01
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 3.0.24
@@ -16,35 +16,33 @@
 require 'catalog-items-api-model/configuration'
 
 # Models
-require 'catalog-items-api-model/models/asin_identifier'
-require 'catalog-items-api-model/models/attribute_set_list'
-require 'catalog-items-api-model/models/attribute_set_list_type'
-require 'catalog-items-api-model/models/categories'
-require 'catalog-items-api-model/models/creator_type'
-require 'catalog-items-api-model/models/decimal_with_units'
-require 'catalog-items-api-model/models/dimension_type'
+require 'catalog-items-api-model/models/brand_refinement'
+require 'catalog-items-api-model/models/classification_refinement'
 require 'catalog-items-api-model/models/error'
 require 'catalog-items-api-model/models/error_list'
-require 'catalog-items-api-model/models/get_catalog_item_response'
-require 'catalog-items-api-model/models/identifier_type'
-require 'catalog-items-api-model/models/image'
 require 'catalog-items-api-model/models/item'
-require 'catalog-items-api-model/models/item_list'
-require 'catalog-items-api-model/models/language_type'
-require 'catalog-items-api-model/models/list_catalog_categories_response'
-require 'catalog-items-api-model/models/list_catalog_items_response'
-require 'catalog-items-api-model/models/list_matching_items_response'
-require 'catalog-items-api-model/models/list_of_categories'
-require 'catalog-items-api-model/models/number_of_offer_listings_list'
-require 'catalog-items-api-model/models/offer_listing_count_type'
-require 'catalog-items-api-model/models/price'
-require 'catalog-items-api-model/models/qualifiers_type'
-require 'catalog-items-api-model/models/relationship_list'
-require 'catalog-items-api-model/models/relationship_type'
-require 'catalog-items-api-model/models/sales_rank_list'
-require 'catalog-items-api-model/models/sales_rank_type'
-require 'catalog-items-api-model/models/seller_sku_identifier'
-require 'catalog-items-api-model/models/shipping_time_type'
+require 'catalog-items-api-model/models/item_asin'
+require 'catalog-items-api-model/models/item_attributes'
+require 'catalog-items-api-model/models/item_identifier'
+require 'catalog-items-api-model/models/item_identifiers'
+require 'catalog-items-api-model/models/item_identifiers_by_marketplace'
+require 'catalog-items-api-model/models/item_image'
+require 'catalog-items-api-model/models/item_images'
+require 'catalog-items-api-model/models/item_images_by_marketplace'
+require 'catalog-items-api-model/models/item_product_type_by_marketplace'
+require 'catalog-items-api-model/models/item_product_types'
+require 'catalog-items-api-model/models/item_sales_rank'
+require 'catalog-items-api-model/models/item_sales_ranks'
+require 'catalog-items-api-model/models/item_sales_ranks_by_marketplace'
+require 'catalog-items-api-model/models/item_search_results'
+require 'catalog-items-api-model/models/item_summaries'
+require 'catalog-items-api-model/models/item_summary_by_marketplace'
+require 'catalog-items-api-model/models/item_variations'
+require 'catalog-items-api-model/models/item_variations_by_marketplace'
+require 'catalog-items-api-model/models/item_vendor_details'
+require 'catalog-items-api-model/models/item_vendor_details_by_marketplace'
+require 'catalog-items-api-model/models/pagination'
+require 'catalog-items-api-model/models/refinements'
 
 # APIs
 require 'catalog-items-api-model/api/catalog_api'

lib/catalog-items-api-model/README.md

@@ -2,11 +2,11 @@
 
 AmzSpApi::CatalogItemsApiModel - the Ruby gem for the Selling Partner API for Catalog Items
 
-The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
+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://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/catalog-items-api-use-case-guide/catalog-items-api-use-case-guide_2020-12-01.md).
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: v0
+- API version: 2020-12-01
 - Package version: 0.1.0
 - Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
 For more information, please visit [https://sellercentral.amazon.com/gp/mws/contactus.html](https://sellercentral.amazon.com/gp/mws/contactus.html)
@@ -56,48 +56,38 @@ Please follow the [installation](#installation) procedure and then run the follo
 require 'catalog-items-api-model'
 
 api_instance = AmzSpApi::CatalogItemsApiModel::CatalogApi.new
-marketplace_id = 'marketplace_id_example' # String | A marketplace identifier. Specifies the marketplace for the item.
 asin = 'asin_example' # String | The Amazon Standard Identification Number (ASIN) of the item.
-
-
-begin
-  result = api_instance.get_catalog_item(marketplace_id, asin)
-  p result
-rescue AmzSpApi::CatalogItemsApiModel::ApiError => e
-  puts "Exception when calling CatalogApi->get_catalog_item: #{e}"
-end
-
-api_instance = AmzSpApi::CatalogItemsApiModel::CatalogApi.new
-marketplace_id = 'marketplace_id_example' # String | A marketplace identifier. Specifies the marketplace for the item.
+marketplace_ids = ['marketplace_ids_example'] # Array<String> | A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
 opts = { 
-  asin: 'asin_example', # String | The Amazon Standard Identification Number (ASIN) of the item.
-  seller_sku: 'seller_sku_example' # 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.
+  included_data: ['included_data_example'], # Array<String> | A comma-delimited list of data sets to include in the response. Default: summaries.
+  locale: 'locale_example' # String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
 }
 
 begin
-  result = api_instance.list_catalog_categories(marketplace_id, opts)
+  result = api_instance.get_catalog_item(asin, marketplace_ids, opts)
   p result
 rescue AmzSpApi::CatalogItemsApiModel::ApiError => e
-  puts "Exception when calling CatalogApi->list_catalog_categories: #{e}"
+  puts "Exception when calling CatalogApi->get_catalog_item: #{e}"
 end
 
 api_instance = AmzSpApi::CatalogItemsApiModel::CatalogApi.new
-marketplace_id = 'marketplace_id_example' # String | A marketplace identifier. Specifies the marketplace for which items are returned.
+keywords = ['keywords_example'] # Array<String> | A comma-delimited list of words or item identifiers to search the Amazon catalog for.
+marketplace_ids = ['marketplace_ids_example'] # Array<String> | A comma-delimited list of Amazon marketplace identifiers for the request.
 opts = { 
-  query: 'query_example', # String | Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'.
-  query_context_id: 'query_context_id_example', # 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.
-  seller_sku: 'seller_sku_example', # 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.
-  upc: 'upc_example', # String | A 12-digit bar code used for retail packaging.
-  ean: 'ean_example', # String | A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
-  isbn: 'isbn_example', # String | The unique commercial book identifier used to identify books internationally.
-  jan: 'jan_example' # String | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
+  included_data: ['included_data_example'], # Array<String> | A comma-delimited list of data sets to include in the response. Default: summaries.
+  brand_names: ['brand_names_example'], # Array<String> | A comma-delimited list of brand names to limit the search to.
+  classification_ids: ['classification_ids_example'], # Array<String> | A comma-delimited list of classification identifiers to limit the search to.
+  page_size: 10, # Integer | Number of results to be returned per page.
+  page_token: 'page_token_example', # String | A token to fetch a certain page when there are multiple pages worth of results.
+  keywords_locale: 'keywords_locale_example', # String | The language the keywords are provided in. Defaults to the primary locale of the marketplace.
+  locale: 'locale_example' # String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
 }
 
 begin
-  result = api_instance.list_catalog_items(marketplace_id, opts)
+  result = api_instance.search_catalog_items(keywords, marketplace_ids, opts)
   p result
 rescue AmzSpApi::CatalogItemsApiModel::ApiError => e
-  puts "Exception when calling CatalogApi->list_catalog_items: #{e}"
+  puts "Exception when calling CatalogApi->search_catalog_items: #{e}"
 end
 ```
 
@@ -107,41 +97,38 @@ All URIs are relative to *https://sellingpartnerapi-na.amazon.com/*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*AmzSpApi::CatalogItemsApiModel::CatalogApi* | [**get_catalog_item**](docs/CatalogApi.md#get_catalog_item) | **GET** /catalog/v0/items/{asin} | 
-*AmzSpApi::CatalogItemsApiModel::CatalogApi* | [**list_catalog_categories**](docs/CatalogApi.md#list_catalog_categories) | **GET** /catalog/v0/categories | 
-*AmzSpApi::CatalogItemsApiModel::CatalogApi* | [**list_catalog_items**](docs/CatalogApi.md#list_catalog_items) | **GET** /catalog/v0/items | 
+*AmzSpApi::CatalogItemsApiModel::CatalogApi* | [**get_catalog_item**](docs/CatalogApi.md#get_catalog_item) | **GET** /catalog/2020-12-01/items/{asin} | 
+*AmzSpApi::CatalogItemsApiModel::CatalogApi* | [**search_catalog_items**](docs/CatalogApi.md#search_catalog_items) | **GET** /catalog/2020-12-01/items | 
 
 ## Documentation for Models
 
- - [AmzSpApi::CatalogItemsApiModel::ASINIdentifier](docs/ASINIdentifier.md)
- - [AmzSpApi::CatalogItemsApiModel::AttributeSetList](docs/AttributeSetList.md)
- - [AmzSpApi::CatalogItemsApiModel::AttributeSetListType](docs/AttributeSetListType.md)
- - [AmzSpApi::CatalogItemsApiModel::Categories](docs/Categories.md)
- - [AmzSpApi::CatalogItemsApiModel::CreatorType](docs/CreatorType.md)
- - [AmzSpApi::CatalogItemsApiModel::DecimalWithUnits](docs/DecimalWithUnits.md)
- - [AmzSpApi::CatalogItemsApiModel::DimensionType](docs/DimensionType.md)
+ - [AmzSpApi::CatalogItemsApiModel::BrandRefinement](docs/BrandRefinement.md)
+ - [AmzSpApi::CatalogItemsApiModel::ClassificationRefinement](docs/ClassificationRefinement.md)
  - [AmzSpApi::CatalogItemsApiModel::Error](docs/Error.md)
  - [AmzSpApi::CatalogItemsApiModel::ErrorList](docs/ErrorList.md)
- - [AmzSpApi::CatalogItemsApiModel::GetCatalogItemResponse](docs/GetCatalogItemResponse.md)
- - [AmzSpApi::CatalogItemsApiModel::IdentifierType](docs/IdentifierType.md)
- - [AmzSpApi::CatalogItemsApiModel::Image](docs/Image.md)
  - [AmzSpApi::CatalogItemsApiModel::Item](docs/Item.md)
- - [AmzSpApi::CatalogItemsApiModel::ItemList](docs/ItemList.md)
- - [AmzSpApi::CatalogItemsApiModel::LanguageType](docs/LanguageType.md)
- - [AmzSpApi::CatalogItemsApiModel::ListCatalogCategoriesResponse](docs/ListCatalogCategoriesResponse.md)
- - [AmzSpApi::CatalogItemsApiModel::ListCatalogItemsResponse](docs/ListCatalogItemsResponse.md)
- - [AmzSpApi::CatalogItemsApiModel::ListMatchingItemsResponse](docs/ListMatchingItemsResponse.md)
- - [AmzSpApi::CatalogItemsApiModel::ListOfCategories](docs/ListOfCategories.md)
- - [AmzSpApi::CatalogItemsApiModel::NumberOfOfferListingsList](docs/NumberOfOfferListingsList.md)
- - [AmzSpApi::CatalogItemsApiModel::OfferListingCountType](docs/OfferListingCountType.md)
- - [AmzSpApi::CatalogItemsApiModel::Price](docs/Price.md)
- - [AmzSpApi::CatalogItemsApiModel::QualifiersType](docs/QualifiersType.md)
- - [AmzSpApi::CatalogItemsApiModel::RelationshipList](docs/RelationshipList.md)
- - [AmzSpApi::CatalogItemsApiModel::RelationshipType](docs/RelationshipType.md)
- - [AmzSpApi::CatalogItemsApiModel::SalesRankList](docs/SalesRankList.md)
- - [AmzSpApi::CatalogItemsApiModel::SalesRankType](docs/SalesRankType.md)
- - [AmzSpApi::CatalogItemsApiModel::SellerSKUIdentifier](docs/SellerSKUIdentifier.md)
- - [AmzSpApi::CatalogItemsApiModel::ShippingTimeType](docs/ShippingTimeType.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemAsin](docs/ItemAsin.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemAttributes](docs/ItemAttributes.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemIdentifier](docs/ItemIdentifier.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemIdentifiers](docs/ItemIdentifiers.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemIdentifiersByMarketplace](docs/ItemIdentifiersByMarketplace.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemImage](docs/ItemImage.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemImages](docs/ItemImages.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemImagesByMarketplace](docs/ItemImagesByMarketplace.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemProductTypeByMarketplace](docs/ItemProductTypeByMarketplace.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemProductTypes](docs/ItemProductTypes.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemSalesRank](docs/ItemSalesRank.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemSalesRanks](docs/ItemSalesRanks.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemSalesRanksByMarketplace](docs/ItemSalesRanksByMarketplace.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemSearchResults](docs/ItemSearchResults.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemSummaries](docs/ItemSummaries.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemSummaryByMarketplace](docs/ItemSummaryByMarketplace.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemVariations](docs/ItemVariations.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemVariationsByMarketplace](docs/ItemVariationsByMarketplace.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemVendorDetails](docs/ItemVendorDetails.md)
+ - [AmzSpApi::CatalogItemsApiModel::ItemVendorDetailsByMarketplace](docs/ItemVendorDetailsByMarketplace.md)
+ - [AmzSpApi::CatalogItemsApiModel::Pagination](docs/Pagination.md)
+ - [AmzSpApi::CatalogItemsApiModel::Refinements](docs/Refinements.md)
 
 ## Documentation for Authorization