@sp-api-sdk/product-type-definitions-api-2020-09-01 1.9.5 → 1.9.8

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/definitions-api.d.ts +9 -9
  2. package/dist/types/src/api-model/common.d.ts +6 -6
  3. package/package.json +7 -5
package/dist/types/src/api-model/api/definitions-api.d.ts CHANGED
@@ -18,7 +18,7 @@ import { ProductTypeList } from '../models';
18
18
  * DefinitionsApi - axios parameter creator
19
19
  * @export
20
20
  */
21
- export declare const DefinitionsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
21
+ export declare const DefinitionsApiAxiosParamCreator: (configuration?: Configuration) => {
22
22
  /**
23
23
  * Retrieve an Amazon product type definition. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [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} productType The Amazon product type name.
@@ -31,7 +31,7 @@ export declare const DefinitionsApiAxiosParamCreator: (configuration?: Configura
31
31
  * @param {*} [options] Override http request option.
32
32
  * @throws {RequiredError}
33
33
  */
34
- getDefinitionsProductType: (productType: string, marketplaceIds: Array<string>, sellerId?: string | undefined, productTypeVersion?: string | undefined, requirements?: "LISTING" | "LISTING_PRODUCT_ONLY" | "LISTING_OFFER_ONLY" | undefined, requirementsEnforced?: "ENFORCED" | "NOT_ENFORCED" | undefined, locale?: "DEFAULT" | "ar" | "ar_AE" | "de" | "de_DE" | "en" | "en_AE" | "en_AU" | "en_CA" | "en_GB" | "en_IN" | "en_SG" | "en_US" | "es" | "es_ES" | "es_MX" | "es_US" | "fr" | "fr_CA" | "fr_FR" | "it" | "it_IT" | "ja" | "ja_JP" | "nl" | "nl_NL" | "pl" | "pl_PL" | "pt" | "pt_BR" | "pt_PT" | "sv" | "sv_SE" | "tr" | "tr_TR" | "zh" | "zh_CN" | "zh_TW" | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ getDefinitionsProductType: (productType: string, marketplaceIds: Array<string>, sellerId?: string, productTypeVersion?: string, requirements?: 'LISTING' | 'LISTING_PRODUCT_ONLY' | 'LISTING_OFFER_ONLY', requirementsEnforced?: 'ENFORCED' | 'NOT_ENFORCED', locale?: 'DEFAULT' | 'ar' | 'ar_AE' | 'de' | 'de_DE' | 'en' | 'en_AE' | 'en_AU' | 'en_CA' | 'en_GB' | 'en_IN' | 'en_SG' | 'en_US' | 'es' | 'es_ES' | 'es_MX' | 'es_US' | 'fr' | 'fr_CA' | 'fr_FR' | 'it' | 'it_IT' | 'ja' | 'ja_JP' | 'nl' | 'nl_NL' | 'pl' | 'pl_PL' | 'pt' | 'pt_BR' | 'pt_PT' | 'sv' | 'sv_SE' | 'tr' | 'tr_TR' | 'zh' | 'zh_CN' | 'zh_TW', options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
35
  /**
36
36
  * Search for and return a list of Amazon product types that have definitions available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [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).
37
37
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
@@ -39,13 +39,13 @@ export declare const DefinitionsApiAxiosParamCreator: (configuration?: Configura
39
39
  * @param {*} [options] Override http request option.
40
40
  * @throws {RequiredError}
41
41
  */
42
- searchDefinitionsProductTypes: (marketplaceIds: Array<string>, keywords?: string[] | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ searchDefinitionsProductTypes: (marketplaceIds: Array<string>, keywords?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
43
  };
44
44
  /**
45
45
  * DefinitionsApi - functional programming interface
46
46
  * @export
47
47
  */
48
- export declare const DefinitionsApiFp: (configuration?: Configuration | undefined) => {
48
+ export declare const DefinitionsApiFp: (configuration?: Configuration) => {
49
49
  /**
50
50
  * Retrieve an Amazon product type definition. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [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).
51
51
  * @param {string} productType The Amazon product type name.
@@ -58,7 +58,7 @@ export declare const DefinitionsApiFp: (configuration?: Configuration | undefine
58
58
  * @param {*} [options] Override http request option.
59
59
  * @throws {RequiredError}
60
60
  */
61
- getDefinitionsProductType(productType: string, marketplaceIds: Array<string>, sellerId?: string | undefined, productTypeVersion?: string | undefined, requirements?: "LISTING" | "LISTING_PRODUCT_ONLY" | "LISTING_OFFER_ONLY" | undefined, requirementsEnforced?: "ENFORCED" | "NOT_ENFORCED" | undefined, locale?: "DEFAULT" | "ar" | "ar_AE" | "de" | "de_DE" | "en" | "en_AE" | "en_AU" | "en_CA" | "en_GB" | "en_IN" | "en_SG" | "en_US" | "es" | "es_ES" | "es_MX" | "es_US" | "fr" | "fr_CA" | "fr_FR" | "it" | "it_IT" | "ja" | "ja_JP" | "nl" | "nl_NL" | "pl" | "pl_PL" | "pt" | "pt_BR" | "pt_PT" | "sv" | "sv_SE" | "tr" | "tr_TR" | "zh" | "zh_CN" | "zh_TW" | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ProductTypeDefinition>>;
61
+ getDefinitionsProductType(productType: string, marketplaceIds: Array<string>, sellerId?: string, productTypeVersion?: string, requirements?: 'LISTING' | 'LISTING_PRODUCT_ONLY' | 'LISTING_OFFER_ONLY', requirementsEnforced?: 'ENFORCED' | 'NOT_ENFORCED', locale?: 'DEFAULT' | 'ar' | 'ar_AE' | 'de' | 'de_DE' | 'en' | 'en_AE' | 'en_AU' | 'en_CA' | 'en_GB' | 'en_IN' | 'en_SG' | 'en_US' | 'es' | 'es_ES' | 'es_MX' | 'es_US' | 'fr' | 'fr_CA' | 'fr_FR' | 'it' | 'it_IT' | 'ja' | 'ja_JP' | 'nl' | 'nl_NL' | 'pl' | 'pl_PL' | 'pt' | 'pt_BR' | 'pt_PT' | 'sv' | 'sv_SE' | 'tr' | 'tr_TR' | 'zh' | 'zh_CN' | 'zh_TW', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductTypeDefinition>>;
62
62
  /**
63
63
  * Search for and return a list of Amazon product types that have definitions available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [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).
64
64
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
@@ -66,13 +66,13 @@ export declare const DefinitionsApiFp: (configuration?: Configuration | undefine
66
66
  * @param {*} [options] Override http request option.
67
67
  * @throws {RequiredError}
68
68
  */
69
- searchDefinitionsProductTypes(marketplaceIds: Array<string>, keywords?: string[] | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<ProductTypeList>>;
69
+ searchDefinitionsProductTypes(marketplaceIds: Array<string>, keywords?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductTypeList>>;
70
70
  };
71
71
  /**
72
72
  * DefinitionsApi - factory interface
73
73
  * @export
74
74
  */
75
- export declare const DefinitionsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
75
+ export declare const DefinitionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
76
76
  /**
77
77
  * Retrieve an Amazon product type definition. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [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).
78
78
  * @param {string} productType The Amazon product type name.
@@ -85,7 +85,7 @@ export declare const DefinitionsApiFactory: (configuration?: Configuration | und
85
85
  * @param {*} [options] Override http request option.
86
86
  * @throws {RequiredError}
87
87
  */
88
- getDefinitionsProductType(productType: string, marketplaceIds: Array<string>, sellerId?: string | undefined, productTypeVersion?: string | undefined, requirements?: "LISTING" | "LISTING_PRODUCT_ONLY" | "LISTING_OFFER_ONLY" | undefined, requirementsEnforced?: "ENFORCED" | "NOT_ENFORCED" | undefined, locale?: "DEFAULT" | "ar" | "ar_AE" | "de" | "de_DE" | "en" | "en_AE" | "en_AU" | "en_CA" | "en_GB" | "en_IN" | "en_SG" | "en_US" | "es" | "es_ES" | "es_MX" | "es_US" | "fr" | "fr_CA" | "fr_FR" | "it" | "it_IT" | "ja" | "ja_JP" | "nl" | "nl_NL" | "pl" | "pl_PL" | "pt" | "pt_BR" | "pt_PT" | "sv" | "sv_SE" | "tr" | "tr_TR" | "zh" | "zh_CN" | "zh_TW" | undefined, options?: any): AxiosPromise<ProductTypeDefinition>;
88
+ getDefinitionsProductType(productType: string, marketplaceIds: Array<string>, sellerId?: string, productTypeVersion?: string, requirements?: 'LISTING' | 'LISTING_PRODUCT_ONLY' | 'LISTING_OFFER_ONLY', requirementsEnforced?: 'ENFORCED' | 'NOT_ENFORCED', locale?: 'DEFAULT' | 'ar' | 'ar_AE' | 'de' | 'de_DE' | 'en' | 'en_AE' | 'en_AU' | 'en_CA' | 'en_GB' | 'en_IN' | 'en_SG' | 'en_US' | 'es' | 'es_ES' | 'es_MX' | 'es_US' | 'fr' | 'fr_CA' | 'fr_FR' | 'it' | 'it_IT' | 'ja' | 'ja_JP' | 'nl' | 'nl_NL' | 'pl' | 'pl_PL' | 'pt' | 'pt_BR' | 'pt_PT' | 'sv' | 'sv_SE' | 'tr' | 'tr_TR' | 'zh' | 'zh_CN' | 'zh_TW', options?: any): AxiosPromise<ProductTypeDefinition>;
89
89
  /**
90
90
  * Search for and return a list of Amazon product types that have definitions available. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [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).
91
91
  * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
@@ -93,7 +93,7 @@ export declare const DefinitionsApiFactory: (configuration?: Configuration | und
93
93
  * @param {*} [options] Override http request option.
94
94
  * @throws {RequiredError}
95
95
  */
96
- searchDefinitionsProductTypes(marketplaceIds: Array<string>, keywords?: string[] | undefined, options?: any): AxiosPromise<ProductTypeList>;
96
+ searchDefinitionsProductTypes(marketplaceIds: Array<string>, keywords?: Array<string>, options?: any): AxiosPromise<ProductTypeList>;
97
97
  };
98
98
  /**
99
99
  * Request parameters for getDefinitionsProductType operation in DefinitionsApi.
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,11 +2,10 @@
2
2
  "name": "@sp-api-sdk/product-type-definitions-api-2020-09-01",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the Product Type Definitions API Use Case Guide.",
5
- "version": "1.9.5",
5
+ "version": "1.9.8",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
9
- "typedocMain": "./index.ts",
10
9
  "license": "MIT",
11
10
  "publishConfig": {
12
11
  "access": "public"
@@ -27,8 +26,8 @@
27
26
  "test": "jest"
28
27
  },
29
28
  "dependencies": {
30
- "@sp-api-sdk/auth": "^1.9.17",
31
- "@sp-api-sdk/common": "^1.9.3",
29
+ "@sp-api-sdk/auth": "^1.9.20",
30
+ "@sp-api-sdk/common": "^1.9.6",
32
31
  "axios": "^0.27.2"
33
32
  },
34
33
  "repository": {
@@ -50,5 +49,8 @@
50
49
  "sp sdk",
51
50
  "product type definitions api"
52
51
  ],
53
- "gitHead": "d4f265d3c6a4e05e45025a46effa023a56a54e9c"
52
+ "typedoc": {
53
+ "entryPoint": "./index.ts"
54
+ },
55
+ "gitHead": "c28c9ce8bfa10271bba79c0067c5c9f63a5f6dc0"
54
56
  }