@sp-api-sdk/catalog-items-api-2022-04-01 2.5.1 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/dist/cjs/api-model/api/{catalog-api.js → catalog-items-api.js} +35 -27
  2. package/dist/cjs/api-model/api.js +2 -2
  3. package/dist/cjs/api-model/base.js +1 -1
  4. package/dist/cjs/api-model/common.js +1 -1
  5. package/dist/cjs/api-model/configuration.js +1 -1
  6. package/dist/cjs/api-model/index.js +1 -1
  7. package/dist/cjs/api-model/models/brand-refinement.js +1 -1
  8. package/dist/cjs/api-model/models/classification-refinement.js +1 -1
  9. package/dist/cjs/api-model/models/dimension.js +1 -1
  10. package/dist/cjs/api-model/models/dimensions.js +1 -1
  11. package/dist/cjs/api-model/models/error-list.js +1 -1
  12. package/dist/cjs/api-model/models/item-browse-classification.js +1 -1
  13. package/dist/cjs/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  14. package/dist/cjs/api-model/models/item-classification-sales-rank.js +1 -1
  15. package/dist/cjs/api-model/models/item-contributor-role.js +1 -1
  16. package/dist/cjs/api-model/models/item-contributor.js +1 -1
  17. package/dist/cjs/api-model/models/item-dimensions-by-marketplace.js +1 -1
  18. package/dist/cjs/api-model/models/item-display-group-sales-rank.js +1 -1
  19. package/dist/cjs/api-model/models/item-identifier.js +1 -1
  20. package/dist/cjs/api-model/models/item-identifiers-by-marketplace.js +1 -1
  21. package/dist/cjs/api-model/models/item-image.js +1 -1
  22. package/dist/cjs/api-model/models/item-images-by-marketplace.js +1 -1
  23. package/dist/cjs/api-model/models/item-product-type-by-marketplace.js +1 -1
  24. package/dist/cjs/api-model/models/item-relationship.js +1 -1
  25. package/dist/cjs/api-model/models/item-relationships-by-marketplace.js +1 -1
  26. package/dist/cjs/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  27. package/dist/cjs/api-model/models/item-search-results.js +1 -1
  28. package/dist/cjs/api-model/models/item-summary-by-marketplace.js +1 -1
  29. package/dist/cjs/api-model/models/item-variation-theme.js +1 -1
  30. package/dist/cjs/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  31. package/dist/cjs/api-model/models/item-vendor-details-category.js +1 -1
  32. package/dist/cjs/api-model/models/item.js +1 -1
  33. package/dist/cjs/api-model/models/model-error.js +1 -1
  34. package/dist/cjs/api-model/models/pagination.js +1 -1
  35. package/dist/cjs/api-model/models/refinements.js +1 -1
  36. package/dist/cjs/client.js +1 -1
  37. package/dist/es/api-model/api/{catalog-api.js → catalog-items-api.js} +30 -22
  38. package/dist/es/api-model/api.js +2 -2
  39. package/dist/es/api-model/base.js +1 -1
  40. package/dist/es/api-model/common.js +1 -1
  41. package/dist/es/api-model/configuration.js +1 -1
  42. package/dist/es/api-model/index.js +1 -1
  43. package/dist/es/api-model/models/brand-refinement.js +1 -1
  44. package/dist/es/api-model/models/classification-refinement.js +1 -1
  45. package/dist/es/api-model/models/dimension.js +1 -1
  46. package/dist/es/api-model/models/dimensions.js +1 -1
  47. package/dist/es/api-model/models/error-list.js +1 -1
  48. package/dist/es/api-model/models/item-browse-classification.js +1 -1
  49. package/dist/es/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  50. package/dist/es/api-model/models/item-classification-sales-rank.js +1 -1
  51. package/dist/es/api-model/models/item-contributor-role.js +1 -1
  52. package/dist/es/api-model/models/item-contributor.js +1 -1
  53. package/dist/es/api-model/models/item-dimensions-by-marketplace.js +1 -1
  54. package/dist/es/api-model/models/item-display-group-sales-rank.js +1 -1
  55. package/dist/es/api-model/models/item-identifier.js +1 -1
  56. package/dist/es/api-model/models/item-identifiers-by-marketplace.js +1 -1
  57. package/dist/es/api-model/models/item-image.js +1 -1
  58. package/dist/es/api-model/models/item-images-by-marketplace.js +1 -1
  59. package/dist/es/api-model/models/item-product-type-by-marketplace.js +1 -1
  60. package/dist/es/api-model/models/item-relationship.js +1 -1
  61. package/dist/es/api-model/models/item-relationships-by-marketplace.js +1 -1
  62. package/dist/es/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  63. package/dist/es/api-model/models/item-search-results.js +1 -1
  64. package/dist/es/api-model/models/item-summary-by-marketplace.js +1 -1
  65. package/dist/es/api-model/models/item-variation-theme.js +1 -1
  66. package/dist/es/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  67. package/dist/es/api-model/models/item-vendor-details-category.js +1 -1
  68. package/dist/es/api-model/models/item.js +1 -1
  69. package/dist/es/api-model/models/model-error.js +1 -1
  70. package/dist/es/api-model/models/pagination.js +1 -1
  71. package/dist/es/api-model/models/refinements.js +1 -1
  72. package/dist/es/client.js +2 -2
  73. package/dist/types/api-model/api/{catalog-api.d.ts → catalog-items-api.d.ts} +50 -42
  74. package/dist/types/api-model/api.d.ts +2 -2
  75. package/dist/types/api-model/base.d.ts +1 -1
  76. package/dist/types/api-model/common.d.ts +1 -1
  77. package/dist/types/api-model/configuration.d.ts +1 -1
  78. package/dist/types/api-model/index.d.ts +1 -1
  79. package/dist/types/api-model/models/brand-refinement.d.ts +1 -1
  80. package/dist/types/api-model/models/classification-refinement.d.ts +1 -1
  81. package/dist/types/api-model/models/dimension.d.ts +1 -1
  82. package/dist/types/api-model/models/dimensions.d.ts +1 -1
  83. package/dist/types/api-model/models/error-list.d.ts +1 -1
  84. package/dist/types/api-model/models/item-browse-classification.d.ts +1 -1
  85. package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +1 -1
  86. package/dist/types/api-model/models/item-classification-sales-rank.d.ts +1 -1
  87. package/dist/types/api-model/models/item-contributor-role.d.ts +1 -1
  88. package/dist/types/api-model/models/item-contributor.d.ts +1 -1
  89. package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +1 -1
  90. package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +1 -1
  91. package/dist/types/api-model/models/item-identifier.d.ts +1 -1
  92. package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +1 -1
  93. package/dist/types/api-model/models/item-image.d.ts +1 -1
  94. package/dist/types/api-model/models/item-images-by-marketplace.d.ts +1 -1
  95. package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +1 -1
  96. package/dist/types/api-model/models/item-relationship.d.ts +1 -1
  97. package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +1 -1
  98. package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +1 -1
  99. package/dist/types/api-model/models/item-search-results.d.ts +1 -1
  100. package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +1 -1
  101. package/dist/types/api-model/models/item-variation-theme.d.ts +1 -1
  102. package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +1 -1
  103. package/dist/types/api-model/models/item-vendor-details-category.d.ts +1 -1
  104. package/dist/types/api-model/models/item.d.ts +1 -1
  105. package/dist/types/api-model/models/model-error.d.ts +1 -1
  106. package/dist/types/api-model/models/pagination.d.ts +1 -1
  107. package/dist/types/api-model/models/refinements.d.ts +1 -1
  108. package/dist/types/client.d.ts +2 -2
  109. package/package.json +3 -3
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -16,12 +16,13 @@ import { type RequestArgs, BaseAPI } from '../base';
16
16
  import type { Item } from '../models';
17
17
  import type { ItemSearchResults } from '../models';
18
18
  /**
19
- * CatalogApi - axios parameter creator
19
+ * CatalogItemsApi - axios parameter creator
20
20
  * @export
21
21
  */
22
- export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ export declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configuration) => {
23
23
  /**
24
24
  * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
25
+ * @summary getCatalogItem
25
26
  * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
26
27
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
27
28
  * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
@@ -32,6 +33,7 @@ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration
32
33
  getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
33
34
  /**
34
35
  * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
36
+ * @summary searchCatalogItems
35
37
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
36
38
  * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
37
39
  * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
@@ -50,12 +52,13 @@ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration
50
52
  searchCatalogItems: (marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51
53
  };
52
54
  /**
53
- * CatalogApi - functional programming interface
55
+ * CatalogItemsApi - functional programming interface
54
56
  * @export
55
57
  */
56
- export declare const CatalogApiFp: (configuration?: Configuration) => {
58
+ export declare const CatalogItemsApiFp: (configuration?: Configuration) => {
57
59
  /**
58
60
  * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
61
+ * @summary getCatalogItem
59
62
  * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
60
63
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
61
64
  * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
@@ -66,6 +69,7 @@ export declare const CatalogApiFp: (configuration?: Configuration) => {
66
69
  getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
67
70
  /**
68
71
  * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
72
+ * @summary searchCatalogItems
69
73
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
70
74
  * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
71
75
  * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
@@ -84,158 +88,162 @@ export declare const CatalogApiFp: (configuration?: Configuration) => {
84
88
  searchCatalogItems(marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemSearchResults>>;
85
89
  };
86
90
  /**
87
- * CatalogApi - factory interface
91
+ * CatalogItemsApi - factory interface
88
92
  * @export
89
93
  */
90
- export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
94
+ export declare const CatalogItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
91
95
  /**
92
96
  * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
93
- * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
97
+ * @summary getCatalogItem
98
+ * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
94
99
  * @param {*} [options] Override http request option.
95
100
  * @throws {RequiredError}
96
101
  */
97
- getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>;
102
+ getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>;
98
103
  /**
99
104
  * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
100
- * @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
105
+ * @summary searchCatalogItems
106
+ * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
101
107
  * @param {*} [options] Override http request option.
102
108
  * @throws {RequiredError}
103
109
  */
104
- searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemSearchResults>;
110
+ searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemSearchResults>;
105
111
  };
106
112
  /**
107
- * Request parameters for getCatalogItem operation in CatalogApi.
113
+ * Request parameters for getCatalogItem operation in CatalogItemsApi.
108
114
  * @export
109
- * @interface CatalogApiGetCatalogItemRequest
115
+ * @interface CatalogItemsApiGetCatalogItemRequest
110
116
  */
111
- export interface CatalogApiGetCatalogItemRequest {
117
+ export interface CatalogItemsApiGetCatalogItemRequest {
112
118
  /**
113
119
  * The Amazon Standard Identification Number (ASIN) of the item.
114
120
  * @type {string}
115
- * @memberof CatalogApiGetCatalogItem
121
+ * @memberof CatalogItemsApiGetCatalogItem
116
122
  */
117
123
  readonly asin: string;
118
124
  /**
119
125
  * A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
120
126
  * @type {Array<string>}
121
- * @memberof CatalogApiGetCatalogItem
127
+ * @memberof CatalogItemsApiGetCatalogItem
122
128
  */
123
129
  readonly marketplaceIds: Array<string>;
124
130
  /**
125
131
  * A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
126
132
  * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
127
- * @memberof CatalogApiGetCatalogItem
133
+ * @memberof CatalogItemsApiGetCatalogItem
128
134
  */
129
135
  readonly includedData?: Array<GetCatalogItemIncludedDataEnum>;
130
136
  /**
131
137
  * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
132
138
  * @type {string}
133
- * @memberof CatalogApiGetCatalogItem
139
+ * @memberof CatalogItemsApiGetCatalogItem
134
140
  */
135
141
  readonly locale?: string;
136
142
  }
137
143
  /**
138
- * Request parameters for searchCatalogItems operation in CatalogApi.
144
+ * Request parameters for searchCatalogItems operation in CatalogItemsApi.
139
145
  * @export
140
- * @interface CatalogApiSearchCatalogItemsRequest
146
+ * @interface CatalogItemsApiSearchCatalogItemsRequest
141
147
  */
142
- export interface CatalogApiSearchCatalogItemsRequest {
148
+ export interface CatalogItemsApiSearchCatalogItemsRequest {
143
149
  /**
144
150
  * A comma-delimited list of Amazon marketplace identifiers for the request.
145
151
  * @type {Array<string>}
146
- * @memberof CatalogApiSearchCatalogItems
152
+ * @memberof CatalogItemsApiSearchCatalogItems
147
153
  */
148
154
  readonly marketplaceIds: Array<string>;
149
155
  /**
150
156
  * A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
151
157
  * @type {Array<string>}
152
- * @memberof CatalogApiSearchCatalogItems
158
+ * @memberof CatalogItemsApiSearchCatalogItems
153
159
  */
154
160
  readonly identifiers?: Array<string>;
155
161
  /**
156
162
  * Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
157
163
  * @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'}
158
- * @memberof CatalogApiSearchCatalogItems
164
+ * @memberof CatalogItemsApiSearchCatalogItems
159
165
  */
160
166
  readonly identifiersType?: SearchCatalogItemsIdentifiersTypeEnum;
161
167
  /**
162
168
  * A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
163
169
  * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
164
- * @memberof CatalogApiSearchCatalogItems
170
+ * @memberof CatalogItemsApiSearchCatalogItems
165
171
  */
166
172
  readonly includedData?: Array<SearchCatalogItemsIncludedDataEnum>;
167
173
  /**
168
174
  * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
169
175
  * @type {string}
170
- * @memberof CatalogApiSearchCatalogItems
176
+ * @memberof CatalogItemsApiSearchCatalogItems
171
177
  */
172
178
  readonly locale?: string;
173
179
  /**
174
180
  * A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
175
181
  * @type {string}
176
- * @memberof CatalogApiSearchCatalogItems
182
+ * @memberof CatalogItemsApiSearchCatalogItems
177
183
  */
178
184
  readonly sellerId?: string;
179
185
  /**
180
186
  * A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
181
187
  * @type {Array<string>}
182
- * @memberof CatalogApiSearchCatalogItems
188
+ * @memberof CatalogItemsApiSearchCatalogItems
183
189
  */
184
190
  readonly keywords?: Array<string>;
185
191
  /**
186
192
  * A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
187
193
  * @type {Array<string>}
188
- * @memberof CatalogApiSearchCatalogItems
194
+ * @memberof CatalogItemsApiSearchCatalogItems
189
195
  */
190
196
  readonly brandNames?: Array<string>;
191
197
  /**
192
198
  * A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
193
199
  * @type {Array<string>}
194
- * @memberof CatalogApiSearchCatalogItems
200
+ * @memberof CatalogItemsApiSearchCatalogItems
195
201
  */
196
202
  readonly classificationIds?: Array<string>;
197
203
  /**
198
204
  * Number of results to be returned per page.
199
205
  * @type {number}
200
- * @memberof CatalogApiSearchCatalogItems
206
+ * @memberof CatalogItemsApiSearchCatalogItems
201
207
  */
202
208
  readonly pageSize?: number;
203
209
  /**
204
210
  * A token to fetch a certain page when there are multiple pages worth of results.
205
211
  * @type {string}
206
- * @memberof CatalogApiSearchCatalogItems
212
+ * @memberof CatalogItemsApiSearchCatalogItems
207
213
  */
208
214
  readonly pageToken?: string;
209
215
  /**
210
216
  * The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
211
217
  * @type {string}
212
- * @memberof CatalogApiSearchCatalogItems
218
+ * @memberof CatalogItemsApiSearchCatalogItems
213
219
  */
214
220
  readonly keywordsLocale?: string;
215
221
  }
216
222
  /**
217
- * CatalogApi - object-oriented interface
223
+ * CatalogItemsApi - object-oriented interface
218
224
  * @export
219
- * @class CatalogApi
225
+ * @class CatalogItemsApi
220
226
  * @extends {BaseAPI}
221
227
  */
222
- export declare class CatalogApi extends BaseAPI {
228
+ export declare class CatalogItemsApi extends BaseAPI {
223
229
  /**
224
230
  * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
225
- * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
231
+ * @summary getCatalogItem
232
+ * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
226
233
  * @param {*} [options] Override http request option.
227
234
  * @throws {RequiredError}
228
- * @memberof CatalogApi
235
+ * @memberof CatalogItemsApi
229
236
  */
230
- getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any>>;
237
+ getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any>>;
231
238
  /**
232
239
  * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
233
- * @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
240
+ * @summary searchCatalogItems
241
+ * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
234
242
  * @param {*} [options] Override http request option.
235
243
  * @throws {RequiredError}
236
- * @memberof CatalogApi
244
+ * @memberof CatalogItemsApi
237
245
  */
238
- searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any>>;
246
+ searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any>>;
239
247
  }
240
248
  /**
241
249
  * @export
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -9,4 +9,4 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- export * from './api/catalog-api';
12
+ export * from './api/catalog-items-api';
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Selling Partner API for Catalog Items
2
+ * Catalog Items v2022-04-01
3
3
  * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
@@ -1,6 +1,6 @@
1
1
  import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
2
- import { CatalogApi } from './api-model';
2
+ import { CatalogItemsApi } from './api-model';
3
3
  export declare const clientRateLimits: RateLimit[];
4
- export declare class CatalogItemsApiClient extends CatalogApi {
4
+ export declare class CatalogItemsApiClient extends CatalogItemsApi {
5
5
  constructor(configuration: ClientConfiguration);
6
6
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/catalog-items-api-2022-04-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "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.",
5
- "version": "2.5.1",
5
+ "version": "2.6.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.1",
21
+ "@sp-api-sdk/common": "2.1.2",
22
22
  "axios": "^1.7.7"
23
23
  },
24
24
  "repository": {
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "catalog items api"
42
42
  ],
43
- "gitHead": "825ea8f0b63dac6d76c36cc7d9984a8693a33e7d"
43
+ "gitHead": "709bf500f3a6a5851b204903c5a0ea2afff80d9a"
44
44
  }