@sp-api-sdk/catalog-items-api-2022-04-01 1.2.0 → 1.2.1

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 (3) hide show
  1. package/dist/types/src/api-model/api/catalog-api.d.ts +9 -9
  2. package/dist/types/src/api-model/common.d.ts +6 -6
  3. package/package.json +4 -4
package/dist/types/src/api-model/api/catalog-api.d.ts CHANGED
@@ -18,7 +18,7 @@ import { ItemSearchResults } from '../models';
18
18
  * CatalogApi - axios parameter creator
19
19
  * @export
20
20
  */
21
- export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
21
+ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => {
22
22
  /**
23
23
  * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | 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).
24
24
  * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
@@ -28,7 +28,7 @@ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration
28
28
  * @param {*} [options] Override http request option.
29
29
  * @throws {RequiredError}
30
30
  */
31
- getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
+ getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
32
  /**
33
33
  * 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 | | ---- | ---- | | 5 | 5 | 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).
34
34
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
@@ -46,13 +46,13 @@ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration
46
46
  * @param {*} [options] Override http request option.
47
47
  * @throws {RequiredError}
48
48
  */
49
- searchCatalogItems: (marketplaceIds: Array<string>, identifiers?: string[] | undefined, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC" | undefined, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, sellerId?: string | undefined, keywords?: string[] | undefined, brandNames?: string[] | undefined, classificationIds?: string[] | undefined, pageSize?: number | undefined, pageToken?: string | undefined, keywordsLocale?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
+ searchCatalogItems: (marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
50
  };
51
51
  /**
52
52
  * CatalogApi - functional programming interface
53
53
  * @export
54
54
  */
55
- export declare const CatalogApiFp: (configuration?: Configuration | undefined) => {
55
+ export declare const CatalogApiFp: (configuration?: Configuration) => {
56
56
  /**
57
57
  * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | 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).
58
58
  * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
@@ -62,7 +62,7 @@ export declare const CatalogApiFp: (configuration?: Configuration | undefined) =
62
62
  * @param {*} [options] Override http request option.
63
63
  * @throws {RequiredError}
64
64
  */
65
- getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Item>>;
65
+ getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
66
66
  /**
67
67
  * 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 | | ---- | ---- | | 5 | 5 | 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).
68
68
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
@@ -80,13 +80,13 @@ export declare const CatalogApiFp: (configuration?: Configuration | undefined) =
80
80
  * @param {*} [options] Override http request option.
81
81
  * @throws {RequiredError}
82
82
  */
83
- searchCatalogItems(marketplaceIds: Array<string>, identifiers?: string[] | undefined, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC" | undefined, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, sellerId?: string | undefined, keywords?: string[] | undefined, brandNames?: string[] | undefined, classificationIds?: string[] | undefined, pageSize?: number | undefined, pageToken?: string | undefined, keywordsLocale?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ItemSearchResults>>;
83
+ searchCatalogItems(marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemSearchResults>>;
84
84
  };
85
85
  /**
86
86
  * CatalogApi - factory interface
87
87
  * @export
88
88
  */
89
- export declare const CatalogApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
89
+ export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
90
90
  /**
91
91
  * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | 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).
92
92
  * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
@@ -96,7 +96,7 @@ export declare const CatalogApiFactory: (configuration?: Configuration | undefin
96
96
  * @param {*} [options] Override http request option.
97
97
  * @throws {RequiredError}
98
98
  */
99
- getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, options?: any): AxiosPromise<Item>;
99
+ getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: any): AxiosPromise<Item>;
100
100
  /**
101
101
  * 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 | | ---- | ---- | | 5 | 5 | 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).
102
102
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
@@ -114,7 +114,7 @@ export declare const CatalogApiFactory: (configuration?: Configuration | undefin
114
114
  * @param {*} [options] Override http request option.
115
115
  * @throws {RequiredError}
116
116
  */
117
- searchCatalogItems(marketplaceIds: Array<string>, identifiers?: string[] | undefined, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC" | undefined, includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[] | undefined, locale?: string | undefined, sellerId?: string | undefined, keywords?: string[] | undefined, brandNames?: string[] | undefined, classificationIds?: string[] | undefined, pageSize?: number | undefined, pageToken?: string | undefined, keywordsLocale?: string | undefined, options?: any): AxiosPromise<ItemSearchResults>;
117
+ searchCatalogItems(marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC', includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any): AxiosPromise<ItemSearchResults>;
118
118
  };
119
119
  /**
120
120
  * Request parameters for getCatalogItem operation in CatalogApi.
package/dist/types/src/api-model/common.d.ts CHANGED
@@ -27,22 +27,22 @@ export declare const assertParamExists: (functionName: string, paramName: string
27
27
  *
28
28
  * @export
29
29
  */
30
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration | undefined) => Promise<void>;
30
+ export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
31
  /**
32
32
  *
33
33
  * @export
34
34
  */
35
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration | undefined) => void;
35
+ export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
36
  /**
37
37
  *
38
38
  * @export
39
39
  */
40
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration | undefined) => Promise<void>;
40
+ export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
41
  /**
42
42
  *
43
43
  * @export
44
44
  */
45
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration | undefined) => Promise<void>;
45
+ export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
46
  /**
47
47
  *
48
48
  * @export
@@ -52,7 +52,7 @@ export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
52
52
  *
53
53
  * @export
54
54
  */
55
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration | undefined) => any;
55
+ export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
56
  /**
57
57
  *
58
58
  * @export
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
62
62
  *
63
63
  * @export
64
64
  */
65
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
65
+ export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/catalog-items-api-2022-04-01",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@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": "1.2.0",
5
+ "version": "1.2.1",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -27,8 +27,8 @@
27
27
  "test": "jest"
28
28
  },
29
29
  "dependencies": {
30
- "@sp-api-sdk/auth": "^1.9.17",
31
- "@sp-api-sdk/common": "^1.9.3",
30
+ "@sp-api-sdk/auth": "^1.9.18",
31
+ "@sp-api-sdk/common": "^1.9.4",
32
32
  "axios": "^0.27.2"
33
33
  },
34
34
  "repository": {
@@ -50,5 +50,5 @@
50
50
  "sp sdk",
51
51
  "catalog items api"
52
52
  ],
53
- "gitHead": "533415989d561d5c67ec399f4d5292c2fc1db6e8"
53
+ "gitHead": "18efdada205f63f94bd5c11e163e758adbb93257"
54
54
  }