@sp-api-sdk/catalog-items-api-v0 1.8.6 → 1.8.10

package/README.md

@@ -2,6 +2,9 @@
 
 The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
 
+[![npm version](https://badgen.net/npm/v/@sp-api-sdk/catalog-items-api-v0)](https://www.npmjs.com/package/@sp-api-sdk/catalog-items-api-v0)
+[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)
+
 ## Documentation
 
 Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/catalog-items-api/catalogItemsV0.md).
@@ -59,7 +62,7 @@ const client = new CatalogItemsApiClient({
 })
 ```
 
-The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/catalog-items-api/catalogItemsV0.md)).
+The rate limits used for each route are specified in the [API documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/catalog-items-api/catalogItemsV0.md).
 
 ## License
 

package/dist/cjs/src/client.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CatalogItemsApiClient = exports.RATE_LIMITS = void 0;
+exports.CatalogItemsApiClient = exports.clientRateLimits = void 0;
 /* eslint-disable prefer-regex-literals */
 const common_1 = require("@sp-api-sdk/common");
 const api_model_1 = require("./api-model");
 const error_1 = require("./error");
-exports.RATE_LIMITS = [
+exports.clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/catalog/v0/items$'),
@@ -27,20 +27,23 @@ exports.RATE_LIMITS = [
 ];
 class CatalogItemsApiClient extends api_model_1.CatalogApi {
     constructor(parameters) {
-        const region = common_1.awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = common_1.sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new error_1.CatalogItemsApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = exports.RATE_LIMITS;
+            axiosParameters.rateLimits = exports.clientRateLimits;
             axiosParameters.onRetry = rateLimiting.onRetry;
         }
         const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
         const configuration = new api_model_1.Configuration();
         const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = common_1.endpoints[environment][region];
-        if (!endpoint) {
-            throw new error_1.CatalogItemsApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/es/src/client.js

@@ -1,8 +1,8 @@
 /* eslint-disable prefer-regex-literals */
-import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
+import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
 import { Configuration, CatalogApi } from './api-model';
 import { CatalogItemsApiError } from './error';
-export const RATE_LIMITS = [
+export const clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/catalog/v0/items$'),
@@ -24,20 +24,23 @@ export const RATE_LIMITS = [
 ];
 export class CatalogItemsApiClient extends CatalogApi {
     constructor(parameters) {
-        const region = awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new CatalogItemsApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = RATE_LIMITS;
+            axiosParameters.rateLimits = clientRateLimits;
             axiosParameters.onRetry = rateLimiting.onRetry;
         }
         const axiosInstance = createAxiosInstance(axiosParameters);
         const configuration = new Configuration();
         const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = endpoints[environment][region];
-        if (!endpoint) {
-            throw new CatalogItemsApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/types/src/client.d.ts

@@ -1,7 +1,8 @@
-import type { ClientConfiguration, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
+import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
 import { CatalogApi } from './api-model';
-export declare const RATE_LIMITS: RateLimit[];
+export declare const clientRateLimits: RateLimit[];
 export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
+    region: SellingPartnerRegion;
     rateLimiting?: {
         retry: boolean;
         onRetry?: OnRetryHandler;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/catalog-items-api-v0",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.",
-  "version": "1.8.6",
+  "version": "1.8.10",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,6 +18,7 @@
     "dist/**/*.d.ts"
   ],
   "scripts": {
+    "check:ts": "yarn tsc --noEmit",
     "build:cjs": "tsc -p tsconfig.json",
     "build:es": "tsc -p tsconfig.es.json",
     "build": "yarn build:cjs && yarn build:es",
@@ -25,9 +26,9 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.5",
-    "@sp-api-sdk/common": "^1.7.7",
-    "axios": "^0.24.0"
+    "@sp-api-sdk/auth": "^1.9.8",
+    "@sp-api-sdk/common": "^1.7.10",
+    "axios": "^0.26.0"
   },
   "repository": {
     "type": "git",
@@ -48,5 +49,5 @@
     "sp sdk",
     "catalog items api"
   ],
-  "gitHead": "e8c21d7d481263e8a6663ee11f6708d4dc6968b6"
+  "gitHead": "3f4ecdeef2ce06ff28612448d263cc8d08eb69f6"
 }

package/dist/cjs/src/api-model/models/offer-listing-count-type.js

@@ -1,15 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/api-model/models/qualifiers-type.js

@@ -1,15 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/api-model/models/shipping-time-type.js

@@ -1,15 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es/src/api-model/models/offer-listing-count-type.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

package/dist/es/src/api-model/models/qualifiers-type.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

package/dist/es/src/api-model/models/shipping-time-type.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

package/dist/types/src/api-model/models/offer-listing-count-type.d.ts

@@ -1,30 +0,0 @@
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * The number of offer listings with the specified condition.
- * @export
- * @interface OfferListingCountType
- */
-export interface OfferListingCountType {
-    /**
-     * The number of offer listings.
-     * @type {number}
-     * @memberof OfferListingCountType
-     */
-    Count: number;
-    /**
-     * The condition of the item.
-     * @type {string}
-     * @memberof OfferListingCountType
-     */
-    condition: string;
-}

package/dist/types/src/api-model/models/qualifiers-type.d.ts

@@ -1,55 +0,0 @@
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { ShippingTimeType } from './shipping-time-type';
-/**
- *
- * @export
- * @interface QualifiersType
- */
-export interface QualifiersType {
-    /**
-     * The condition of the item. Possible values: New, Used, Collectible, Refurbished, or Club.
-     * @type {string}
-     * @memberof QualifiersType
-     */
-    ItemCondition: string;
-    /**
-     * The item subcondition for the offer listing. Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other.
-     * @type {string}
-     * @memberof QualifiersType
-     */
-    ItemSubcondition: string;
-    /**
-     * The fulfillment channel for the item. Possible values:  * Amazon - Fulfilled by Amazon. * Merchant - Fulfilled by the seller.
-     * @type {string}
-     * @memberof QualifiersType
-     */
-    FulfillmentChannel: string;
-    /**
-     * Indicates whether the marketplace specified in the request and the location that the item ships from are in the same country. Possible values: True, False, or Unknown.
-     * @type {string}
-     * @memberof QualifiersType
-     */
-    ShipsDomestically: string;
-    /**
-     *
-     * @type {ShippingTimeType}
-     * @memberof QualifiersType
-     */
-    ShippingTime: ShippingTimeType;
-    /**
-     * (98-100%, 95-97%, 90-94%, 80-89%, 70-79%, Less than 70%, or Just launched ) – Indicates the percentage of feedback ratings that were positive over the past 12 months.
-     * @type {string}
-     * @memberof QualifiersType
-     */
-    SellerPositiveFeedbackRating: string;
-}

package/dist/types/src/api-model/models/shipping-time-type.d.ts

@@ -1,24 +0,0 @@
-/**
- * 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 version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface ShippingTimeType
- */
-export interface ShippingTimeType {
-    /**
-     * (0-2 days, 3-7 days, 8-13 days, or 14 or more days) – Indicates the maximum time within which the item will likely be shipped once an order has been placed.
-     * @type {string}
-     * @memberof ShippingTimeType
-     */
-    Max?: string;
-}