@sp-api-sdk/catalog-items-api-2022-04-01 3.1.0 → 3.2.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/README.md +4 -4
  2. package/dist/cjs/api-model/api/catalog-api.js +37 -37
  3. package/dist/cjs/api-model/api.js +1 -1
  4. package/dist/cjs/api-model/base.js +1 -1
  5. package/dist/cjs/api-model/common.js +1 -1
  6. package/dist/cjs/api-model/configuration.js +1 -1
  7. package/dist/cjs/api-model/index.js +1 -1
  8. package/dist/cjs/api-model/models/brand-refinement.js +1 -1
  9. package/dist/cjs/api-model/models/classification-refinement.js +1 -1
  10. package/dist/cjs/api-model/models/dimension.js +1 -1
  11. package/dist/cjs/api-model/models/dimensions.js +1 -1
  12. package/dist/cjs/api-model/models/error-list.js +1 -1
  13. package/dist/cjs/api-model/models/item-browse-classification.js +1 -1
  14. package/dist/cjs/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  15. package/dist/cjs/api-model/models/item-classification-sales-rank.js +1 -1
  16. package/dist/cjs/api-model/models/item-contributor-role.js +1 -1
  17. package/dist/cjs/api-model/models/item-contributor.js +1 -1
  18. package/dist/cjs/api-model/models/item-dimensions-by-marketplace.js +1 -1
  19. package/dist/cjs/api-model/models/item-display-group-sales-rank.js +1 -1
  20. package/dist/cjs/api-model/models/item-identifier.js +1 -1
  21. package/dist/cjs/api-model/models/item-identifiers-by-marketplace.js +1 -1
  22. package/dist/cjs/api-model/models/item-image.js +1 -1
  23. package/dist/cjs/api-model/models/item-images-by-marketplace.js +1 -1
  24. package/dist/cjs/api-model/models/item-product-type-by-marketplace.js +1 -1
  25. package/dist/cjs/api-model/models/item-relationship.js +1 -1
  26. package/dist/cjs/api-model/models/item-relationships-by-marketplace.js +1 -1
  27. package/dist/cjs/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  28. package/dist/cjs/api-model/models/item-search-results.js +1 -1
  29. package/dist/cjs/api-model/models/item-summary-by-marketplace.js +1 -1
  30. package/dist/cjs/api-model/models/item-variation-theme.js +1 -1
  31. package/dist/cjs/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  32. package/dist/cjs/api-model/models/item-vendor-details-category.js +1 -1
  33. package/dist/cjs/api-model/models/item.js +1 -1
  34. package/dist/cjs/api-model/models/model-error.js +1 -1
  35. package/dist/cjs/api-model/models/pagination.js +1 -1
  36. package/dist/cjs/api-model/models/refinements.js +1 -1
  37. package/dist/cjs/client.js +4 -4
  38. package/dist/es/api-model/api/catalog-api.js +37 -37
  39. package/dist/es/api-model/api.js +1 -1
  40. package/dist/es/api-model/base.js +1 -1
  41. package/dist/es/api-model/common.js +1 -1
  42. package/dist/es/api-model/configuration.js +1 -1
  43. package/dist/es/api-model/index.js +1 -1
  44. package/dist/es/api-model/models/brand-refinement.js +1 -1
  45. package/dist/es/api-model/models/classification-refinement.js +1 -1
  46. package/dist/es/api-model/models/dimension.js +1 -1
  47. package/dist/es/api-model/models/dimensions.js +1 -1
  48. package/dist/es/api-model/models/error-list.js +1 -1
  49. package/dist/es/api-model/models/item-browse-classification.js +1 -1
  50. package/dist/es/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  51. package/dist/es/api-model/models/item-classification-sales-rank.js +1 -1
  52. package/dist/es/api-model/models/item-contributor-role.js +1 -1
  53. package/dist/es/api-model/models/item-contributor.js +1 -1
  54. package/dist/es/api-model/models/item-dimensions-by-marketplace.js +1 -1
  55. package/dist/es/api-model/models/item-display-group-sales-rank.js +1 -1
  56. package/dist/es/api-model/models/item-identifier.js +1 -1
  57. package/dist/es/api-model/models/item-identifiers-by-marketplace.js +1 -1
  58. package/dist/es/api-model/models/item-image.js +1 -1
  59. package/dist/es/api-model/models/item-images-by-marketplace.js +1 -1
  60. package/dist/es/api-model/models/item-product-type-by-marketplace.js +1 -1
  61. package/dist/es/api-model/models/item-relationship.js +1 -1
  62. package/dist/es/api-model/models/item-relationships-by-marketplace.js +1 -1
  63. package/dist/es/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  64. package/dist/es/api-model/models/item-search-results.js +1 -1
  65. package/dist/es/api-model/models/item-summary-by-marketplace.js +1 -1
  66. package/dist/es/api-model/models/item-variation-theme.js +1 -1
  67. package/dist/es/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  68. package/dist/es/api-model/models/item-vendor-details-category.js +1 -1
  69. package/dist/es/api-model/models/item.js +1 -1
  70. package/dist/es/api-model/models/model-error.js +1 -1
  71. package/dist/es/api-model/models/pagination.js +1 -1
  72. package/dist/es/api-model/models/refinements.js +1 -1
  73. package/dist/es/client.js +4 -4
  74. package/dist/types/api-model/api/catalog-api.d.ts +51 -51
  75. package/dist/types/api-model/api.d.ts +1 -1
  76. package/dist/types/api-model/base.d.ts +1 -1
  77. package/dist/types/api-model/common.d.ts +1 -1
  78. package/dist/types/api-model/configuration.d.ts +1 -1
  79. package/dist/types/api-model/index.d.ts +1 -1
  80. package/dist/types/api-model/models/brand-refinement.d.ts +4 -4
  81. package/dist/types/api-model/models/classification-refinement.d.ts +4 -4
  82. package/dist/types/api-model/models/dimension.d.ts +4 -4
  83. package/dist/types/api-model/models/dimensions.d.ts +1 -1
  84. package/dist/types/api-model/models/error-list.d.ts +1 -1
  85. package/dist/types/api-model/models/item-browse-classification.d.ts +4 -4
  86. package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +4 -4
  87. package/dist/types/api-model/models/item-classification-sales-rank.d.ts +6 -6
  88. package/dist/types/api-model/models/item-contributor-role.d.ts +3 -3
  89. package/dist/types/api-model/models/item-contributor.d.ts +2 -2
  90. package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +3 -3
  91. package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +6 -6
  92. package/dist/types/api-model/models/item-identifier.d.ts +3 -3
  93. package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +4 -4
  94. package/dist/types/api-model/models/item-image.d.ts +2 -2
  95. package/dist/types/api-model/models/item-images-by-marketplace.d.ts +4 -4
  96. package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +4 -4
  97. package/dist/types/api-model/models/item-relationship.d.ts +3 -3
  98. package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +3 -3
  99. package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +5 -5
  100. package/dist/types/api-model/models/item-search-results.d.ts +3 -3
  101. package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +21 -21
  102. package/dist/types/api-model/models/item-variation-theme.d.ts +4 -4
  103. package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +8 -8
  104. package/dist/types/api-model/models/item-vendor-details-category.d.ts +4 -4
  105. package/dist/types/api-model/models/item.d.ts +10 -10
  106. package/dist/types/api-model/models/model-error.d.ts +1 -1
  107. package/dist/types/api-model/models/pagination.d.ts +4 -4
  108. package/dist/types/api-model/models/refinements.d.ts +4 -4
  109. package/package.json +5 -5
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
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).
3
+ * Use the Selling Partner API for Catalog Items to retrieve 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
6
6
  *
@@ -25,13 +25,13 @@ import type { ItemVendorDetailsByMarketplace } from './item-vendor-details-by-ma
25
25
  */
26
26
  export interface Item {
27
27
  /**
28
- * Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog.
28
+ * The unique identifier of an item in the Amazon catalog.
29
29
  * @type {string}
30
30
  * @memberof Item
31
31
  */
32
32
  'asin': string;
33
33
  /**
34
- * A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes conform to the related product type definitions available in the Selling Partner API for Product Type Definitions.
34
+ * A JSON object containing structured item attribute data that is keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions that you can get from the [Product Type Definitions API](https://developer-docs.amazon.com/sp-api/docs/product-type-definitions-api-v2020-09-01-reference).
35
35
  * @type {{ [key: string]: any; }}
36
36
  * @memberof Item
37
37
  */
@@ -39,13 +39,13 @@ export interface Item {
39
39
  [key: string]: any;
40
40
  };
41
41
  /**
42
- * Array of classifications (browse nodes) associated with the item in the Amazon catalog by Amazon marketplace.
42
+ * An array of classifications (browse nodes) that is associated with the item in the Amazon catalog, grouped by `marketplaceId`.
43
43
  * @type {Array<ItemBrowseClassificationsByMarketplace>}
44
44
  * @memberof Item
45
45
  */
46
46
  'classifications'?: Array<ItemBrowseClassificationsByMarketplace>;
47
47
  /**
48
- * Array of dimensions associated with the item in the Amazon catalog by Amazon marketplace.
48
+ * An array of dimensions that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
49
49
  * @type {Array<ItemDimensionsByMarketplace>}
50
50
  * @memberof Item
51
51
  */
@@ -57,19 +57,19 @@ export interface Item {
57
57
  */
58
58
  'identifiers'?: Array<ItemIdentifiersByMarketplace>;
59
59
  /**
60
- * Images for an item in the Amazon catalog.
60
+ * The images for an item in the Amazon catalog.
61
61
  * @type {Array<ItemImagesByMarketplace>}
62
62
  * @memberof Item
63
63
  */
64
64
  'images'?: Array<ItemImagesByMarketplace>;
65
65
  /**
66
- * Product types associated with the Amazon catalog item.
66
+ * Product types that are associated with the Amazon catalog item.
67
67
  * @type {Array<ItemProductTypeByMarketplace>}
68
68
  * @memberof Item
69
69
  */
70
70
  'productTypes'?: Array<ItemProductTypeByMarketplace>;
71
71
  /**
72
- * Relationships by marketplace for an Amazon catalog item (for example, variations).
72
+ * Relationships grouped by `marketplaceId` for an Amazon catalog item (for example, variations).
73
73
  * @type {Array<ItemRelationshipsByMarketplace>}
74
74
  * @memberof Item
75
75
  */
@@ -81,13 +81,13 @@ export interface Item {
81
81
  */
82
82
  'salesRanks'?: Array<ItemSalesRanksByMarketplace>;
83
83
  /**
84
- * Summary details of an Amazon catalog item.
84
+ * Summaries of Amazon catalog items.
85
85
  * @type {Array<ItemSummaryByMarketplace>}
86
86
  * @memberof Item
87
87
  */
88
88
  'summaries'?: Array<ItemSummaryByMarketplace>;
89
89
  /**
90
- * Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only.
90
+ * The vendor details that are associated with an Amazon catalog item. Vendor details are only available to vendors.
91
91
  * @type {Array<ItemVendorDetailsByMarketplace>}
92
92
  * @memberof Item
93
93
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
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).
3
+ * Use the Selling Partner API for Catalog Items to retrieve 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
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
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).
3
+ * Use the Selling Partner API for Catalog Items to retrieve 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
6
6
  *
@@ -10,19 +10,19 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object.
13
+ * Pagination occurs when a request produces a response that exceeds the `pageSize`. This means that the response is divided into individual pages. To retrieve the next page or the previous page of results, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. There is no `nextToken` in the pagination object on the last page.
14
14
  * @export
15
15
  * @interface Pagination
16
16
  */
17
17
  export interface Pagination {
18
18
  /**
19
- * A token that can be used to fetch the next page.
19
+ * A token that you can use to retrieve the next page.
20
20
  * @type {string}
21
21
  * @memberof Pagination
22
22
  */
23
23
  'nextToken'?: string;
24
24
  /**
25
- * A token that can be used to fetch the previous page.
25
+ * A token that you can use to retrieve the previous page.
26
26
  * @type {string}
27
27
  * @memberof Pagination
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
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).
3
+ * Use the Selling Partner API for Catalog Items to retrieve 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
6
6
  *
@@ -12,19 +12,19 @@
12
12
  import type { BrandRefinement } from './brand-refinement';
13
13
  import type { ClassificationRefinement } from './classification-refinement';
14
14
  /**
15
- * Search refinements.
15
+ * Optional fields that you can use to refine your search results.
16
16
  * @export
17
17
  * @interface Refinements
18
18
  */
19
19
  export interface Refinements {
20
20
  /**
21
- * Brand search refinements.
21
+ * A list of brands you can use to refine your search.
22
22
  * @type {Array<BrandRefinement>}
23
23
  * @memberof Refinements
24
24
  */
25
25
  'brands': Array<BrandRefinement>;
26
26
  /**
27
- * Classification search refinements.
27
+ * A list of classifications you can use to refine your search.
28
28
  * @type {Array<ClassificationRefinement>}
29
29
  * @memberof Refinements
30
30
  */
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@sp-api-sdk/catalog-items-api-2022-04-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
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": "3.1.0",
4
+ "description": "Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the Catalog Items API Use Case Guide.",
5
+ "version": "3.2.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.11",
22
- "axios": "^1.8.1"
21
+ "@sp-api-sdk/common": "2.1.13",
22
+ "axios": "^1.8.4"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "catalog items api"
42
42
  ],
43
- "gitHead": "b5799742765e819f70161d2ac1905d8e570de8c0"
43
+ "gitHead": "287508bdc050a25bac20889ed0afb6d3f6518cd6"
44
44
  }