@sp-api-sdk/product-pricing-api-2022-05-01 3.2.15 → 4.0.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 (161) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +474 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +1325 -0
  5. package/dist/index.d.ts +1325 -0
  6. package/dist/index.js +422 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/product-pricing-api.js +0 -177
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/batch-request.js +0 -15
  16. package/dist/cjs/api-model/models/batch-response.js +0 -15
  17. package/dist/cjs/api-model/models/competitive-summary-batch-request.js +0 -15
  18. package/dist/cjs/api-model/models/competitive-summary-batch-response.js +0 -15
  19. package/dist/cjs/api-model/models/competitive-summary-included-data.js +0 -24
  20. package/dist/cjs/api-model/models/competitive-summary-request.js +0 -15
  21. package/dist/cjs/api-model/models/competitive-summary-response-body.js +0 -15
  22. package/dist/cjs/api-model/models/competitive-summary-response.js +0 -15
  23. package/dist/cjs/api-model/models/condition.js +0 -26
  24. package/dist/cjs/api-model/models/errors.js +0 -15
  25. package/dist/cjs/api-model/models/featured-buying-option.js +0 -19
  26. package/dist/cjs/api-model/models/featured-offer-expected-price-request-params.js +0 -15
  27. package/dist/cjs/api-model/models/featured-offer-expected-price-request.js +0 -15
  28. package/dist/cjs/api-model/models/featured-offer-expected-price-response-all-of.js +0 -15
  29. package/dist/cjs/api-model/models/featured-offer-expected-price-response-body.js +0 -15
  30. package/dist/cjs/api-model/models/featured-offer-expected-price-response.js +0 -15
  31. package/dist/cjs/api-model/models/featured-offer-expected-price-result.js +0 -15
  32. package/dist/cjs/api-model/models/featured-offer-expected-price.js +0 -15
  33. package/dist/cjs/api-model/models/featured-offer-segment.js +0 -21
  34. package/dist/cjs/api-model/models/featured-offer.js +0 -15
  35. package/dist/cjs/api-model/models/fulfillment-type.js +0 -23
  36. package/dist/cjs/api-model/models/get-featured-offer-expected-price-batch-request.js +0 -15
  37. package/dist/cjs/api-model/models/get-featured-offer-expected-price-batch-response.js +0 -15
  38. package/dist/cjs/api-model/models/http-method.js +0 -26
  39. package/dist/cjs/api-model/models/http-status-line.js +0 -15
  40. package/dist/cjs/api-model/models/index.js +0 -58
  41. package/dist/cjs/api-model/models/lowest-priced-offer.js +0 -15
  42. package/dist/cjs/api-model/models/lowest-priced-offers-input.js +0 -19
  43. package/dist/cjs/api-model/models/model-error.js +0 -15
  44. package/dist/cjs/api-model/models/money-type.js +0 -15
  45. package/dist/cjs/api-model/models/offer-identifier.js +0 -15
  46. package/dist/cjs/api-model/models/offer.js +0 -31
  47. package/dist/cjs/api-model/models/points.js +0 -15
  48. package/dist/cjs/api-model/models/postal-code.js +0 -15
  49. package/dist/cjs/api-model/models/price.js +0 -15
  50. package/dist/cjs/api-model/models/prime-details.js +0 -21
  51. package/dist/cjs/api-model/models/reference-price.js +0 -15
  52. package/dist/cjs/api-model/models/sample-location.js +0 -15
  53. package/dist/cjs/api-model/models/segment-details.js +0 -15
  54. package/dist/cjs/api-model/models/segment.js +0 -15
  55. package/dist/cjs/api-model/models/segmented-featured-offer-all-of.js +0 -15
  56. package/dist/cjs/api-model/models/segmented-featured-offer.js +0 -15
  57. package/dist/cjs/api-model/models/shipping-option.js +0 -19
  58. package/dist/cjs/client.js +0 -28
  59. package/dist/cjs/index.js +0 -19
  60. package/dist/es/api-model/api/product-pricing-api.js +0 -167
  61. package/dist/es/api-model/api.js +0 -14
  62. package/dist/es/api-model/base.js +0 -44
  63. package/dist/es/api-model/common.js +0 -110
  64. package/dist/es/api-model/configuration.js +0 -94
  65. package/dist/es/api-model/index.js +0 -16
  66. package/dist/es/api-model/models/batch-request.js +0 -14
  67. package/dist/es/api-model/models/batch-response.js +0 -14
  68. package/dist/es/api-model/models/competitive-summary-batch-request.js +0 -14
  69. package/dist/es/api-model/models/competitive-summary-batch-response.js +0 -14
  70. package/dist/es/api-model/models/competitive-summary-included-data.js +0 -21
  71. package/dist/es/api-model/models/competitive-summary-request.js +0 -14
  72. package/dist/es/api-model/models/competitive-summary-response-body.js +0 -14
  73. package/dist/es/api-model/models/competitive-summary-response.js +0 -14
  74. package/dist/es/api-model/models/condition.js +0 -23
  75. package/dist/es/api-model/models/errors.js +0 -14
  76. package/dist/es/api-model/models/featured-buying-option.js +0 -16
  77. package/dist/es/api-model/models/featured-offer-expected-price-request-params.js +0 -14
  78. package/dist/es/api-model/models/featured-offer-expected-price-request.js +0 -14
  79. package/dist/es/api-model/models/featured-offer-expected-price-response-all-of.js +0 -14
  80. package/dist/es/api-model/models/featured-offer-expected-price-response-body.js +0 -14
  81. package/dist/es/api-model/models/featured-offer-expected-price-response.js +0 -14
  82. package/dist/es/api-model/models/featured-offer-expected-price-result.js +0 -14
  83. package/dist/es/api-model/models/featured-offer-expected-price.js +0 -14
  84. package/dist/es/api-model/models/featured-offer-segment.js +0 -18
  85. package/dist/es/api-model/models/featured-offer.js +0 -14
  86. package/dist/es/api-model/models/fulfillment-type.js +0 -20
  87. package/dist/es/api-model/models/get-featured-offer-expected-price-batch-request.js +0 -14
  88. package/dist/es/api-model/models/get-featured-offer-expected-price-batch-response.js +0 -14
  89. package/dist/es/api-model/models/http-method.js +0 -23
  90. package/dist/es/api-model/models/http-status-line.js +0 -14
  91. package/dist/es/api-model/models/index.js +0 -42
  92. package/dist/es/api-model/models/lowest-priced-offer.js +0 -14
  93. package/dist/es/api-model/models/lowest-priced-offers-input.js +0 -16
  94. package/dist/es/api-model/models/model-error.js +0 -14
  95. package/dist/es/api-model/models/money-type.js +0 -14
  96. package/dist/es/api-model/models/offer-identifier.js +0 -14
  97. package/dist/es/api-model/models/offer.js +0 -28
  98. package/dist/es/api-model/models/points.js +0 -14
  99. package/dist/es/api-model/models/postal-code.js +0 -14
  100. package/dist/es/api-model/models/price.js +0 -14
  101. package/dist/es/api-model/models/prime-details.js +0 -18
  102. package/dist/es/api-model/models/reference-price.js +0 -14
  103. package/dist/es/api-model/models/sample-location.js +0 -14
  104. package/dist/es/api-model/models/segment-details.js +0 -14
  105. package/dist/es/api-model/models/segment.js +0 -14
  106. package/dist/es/api-model/models/segmented-featured-offer-all-of.js +0 -14
  107. package/dist/es/api-model/models/segmented-featured-offer.js +0 -14
  108. package/dist/es/api-model/models/shipping-option.js +0 -16
  109. package/dist/es/client.js +0 -24
  110. package/dist/es/index.js +0 -3
  111. package/dist/types/api-model/api/product-pricing-api.d.ts +0 -113
  112. package/dist/types/api-model/api.d.ts +0 -12
  113. package/dist/types/api-model/base.d.ts +0 -42
  114. package/dist/types/api-model/common.d.ts +0 -34
  115. package/dist/types/api-model/configuration.d.ts +0 -98
  116. package/dist/types/api-model/index.d.ts +0 -14
  117. package/dist/types/api-model/models/batch-request.d.ts +0 -34
  118. package/dist/types/api-model/models/batch-response.d.ts +0 -24
  119. package/dist/types/api-model/models/competitive-summary-batch-request.d.ts +0 -21
  120. package/dist/types/api-model/models/competitive-summary-batch-response.d.ts +0 -21
  121. package/dist/types/api-model/models/competitive-summary-included-data.d.ts +0 -20
  122. package/dist/types/api-model/models/competitive-summary-request.d.ts +0 -40
  123. package/dist/types/api-model/models/competitive-summary-response-body.d.ts +0 -43
  124. package/dist/types/api-model/models/competitive-summary-response.d.ts +0 -20
  125. package/dist/types/api-model/models/condition.d.ts +0 -22
  126. package/dist/types/api-model/models/errors.d.ts +0 -20
  127. package/dist/types/api-model/models/featured-buying-option.d.ts +0 -29
  128. package/dist/types/api-model/models/featured-offer-expected-price-request-params.d.ts +0 -26
  129. package/dist/types/api-model/models/featured-offer-expected-price-request.d.ts +0 -18
  130. package/dist/types/api-model/models/featured-offer-expected-price-response-all-of.d.ts +0 -17
  131. package/dist/types/api-model/models/featured-offer-expected-price-response-body.d.ts +0 -27
  132. package/dist/types/api-model/models/featured-offer-expected-price-response.d.ts +0 -18
  133. package/dist/types/api-model/models/featured-offer-expected-price-result.d.ts +0 -25
  134. package/dist/types/api-model/models/featured-offer-expected-price.d.ts +0 -20
  135. package/dist/types/api-model/models/featured-offer-segment.d.ts +0 -28
  136. package/dist/types/api-model/models/featured-offer.d.ts +0 -22
  137. package/dist/types/api-model/models/fulfillment-type.d.ts +0 -19
  138. package/dist/types/api-model/models/get-featured-offer-expected-price-batch-request.d.ts +0 -21
  139. package/dist/types/api-model/models/get-featured-offer-expected-price-batch-response.d.ts +0 -21
  140. package/dist/types/api-model/models/http-method.d.ts +0 -22
  141. package/dist/types/api-model/models/http-status-line.d.ts +0 -24
  142. package/dist/types/api-model/models/index.d.ts +0 -42
  143. package/dist/types/api-model/models/lowest-priced-offer.d.ts +0 -23
  144. package/dist/types/api-model/models/lowest-priced-offers-input.d.ts +0 -26
  145. package/dist/types/api-model/models/model-error.d.ts +0 -28
  146. package/dist/types/api-model/models/money-type.d.ts +0 -24
  147. package/dist/types/api-model/models/offer-identifier.d.ts +0 -34
  148. package/dist/types/api-model/models/offer.d.ts +0 -55
  149. package/dist/types/api-model/models/points.d.ts +0 -22
  150. package/dist/types/api-model/models/postal-code.d.ts +0 -24
  151. package/dist/types/api-model/models/price.d.ts +0 -21
  152. package/dist/types/api-model/models/prime-details.d.ts +0 -26
  153. package/dist/types/api-model/models/reference-price.d.ts +0 -22
  154. package/dist/types/api-model/models/sample-location.d.ts +0 -18
  155. package/dist/types/api-model/models/segment-details.d.ts +0 -22
  156. package/dist/types/api-model/models/segment.d.ts +0 -18
  157. package/dist/types/api-model/models/segmented-featured-offer-all-of.d.ts +0 -21
  158. package/dist/types/api-model/models/segmented-featured-offer.d.ts +0 -18
  159. package/dist/types/api-model/models/shipping-option.d.ts +0 -26
  160. package/dist/types/client.d.ts +0 -6
  161. package/dist/types/index.d.ts +0 -3
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Pricing
5
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
- *
7
- * The version of the OpenAPI document: 2022-05-01
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Pricing
5
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
- *
7
- * The version of the OpenAPI document: 2022-05-01
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Pricing
5
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
- *
7
- * The version of the OpenAPI document: 2022-05-01
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,16 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Selling Partner API for Pricing
5
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
- *
7
- * The version of the OpenAPI document: 2022-05-01
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export const ShippingOptionShippingOptionTypeEnum = {
15
- Default: 'DEFAULT'
16
- };
package/dist/es/client.js DELETED
@@ -1,24 +0,0 @@
1
- import { createAxiosInstance } from '@sp-api-sdk/common';
2
- import { Configuration, ProductPricingApi } from './api-model';
3
- export const clientRateLimits = [
4
- {
5
- method: 'post',
6
- // eslint-disable-next-line prefer-regex-literals
7
- urlRegex: new RegExp('^/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice$'),
8
- rate: 0.033,
9
- burst: 1,
10
- },
11
- {
12
- method: 'post',
13
- // eslint-disable-next-line prefer-regex-literals
14
- urlRegex: new RegExp('^/batches/products/pricing/2022-05-01/items/competitiveSummary$'),
15
- rate: 0.033,
16
- burst: 1,
17
- },
18
- ];
19
- export class ProductPricingApiClient extends ProductPricingApi {
20
- constructor(configuration) {
21
- const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
22
- super(new Configuration(), endpoint, axios);
23
- }
24
- }
package/dist/es/index.js DELETED
@@ -1,3 +0,0 @@
1
- export * from './client';
2
- export * from './api-model/api';
3
- export * from './api-model/models';
@@ -1,113 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { CompetitiveSummaryBatchRequest } from '../models';
17
- import type { CompetitiveSummaryBatchResponse } from '../models';
18
- import type { GetFeaturedOfferExpectedPriceBatchRequest } from '../models';
19
- import type { GetFeaturedOfferExpectedPriceBatchResponse } from '../models';
20
- /**
21
- * ProductPricingApi - axios parameter creator
22
- */
23
- export declare const ProductPricingApiAxiosParamCreator: (configuration?: Configuration) => {
24
- /**
25
- * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
26
- * @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests.
27
- * @param {*} [options] Override http request option.
28
- * @throws {RequiredError}
29
- */
30
- getCompetitiveSummary: (requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31
- /**
32
- * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
33
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
34
- * @param {*} [options] Override http request option.
35
- * @throws {RequiredError}
36
- */
37
- getFeaturedOfferExpectedPriceBatch: (getFeaturedOfferExpectedPriceBatchRequestBody: GetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
- };
39
- /**
40
- * ProductPricingApi - functional programming interface
41
- */
42
- export declare const ProductPricingApiFp: (configuration?: Configuration) => {
43
- /**
44
- * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
45
- * @param {CompetitiveSummaryBatchRequest} requests The batch of &#x60;getCompetitiveSummary&#x60; requests.
46
- * @param {*} [options] Override http request option.
47
- * @throws {RequiredError}
48
- */
49
- getCompetitiveSummary(requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompetitiveSummaryBatchResponse>>;
50
- /**
51
- * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
52
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
53
- * @param {*} [options] Override http request option.
54
- * @throws {RequiredError}
55
- */
56
- getFeaturedOfferExpectedPriceBatch(getFeaturedOfferExpectedPriceBatchRequestBody: GetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeaturedOfferExpectedPriceBatchResponse>>;
57
- };
58
- /**
59
- * ProductPricingApi - factory interface
60
- */
61
- export declare const ProductPricingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
62
- /**
63
- * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
64
- * @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
65
- * @param {*} [options] Override http request option.
66
- * @throws {RequiredError}
67
- */
68
- getCompetitiveSummary(requestParameters: ProductPricingApiGetCompetitiveSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<CompetitiveSummaryBatchResponse>;
69
- /**
70
- * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
71
- * @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
72
- * @param {*} [options] Override http request option.
73
- * @throws {RequiredError}
74
- */
75
- getFeaturedOfferExpectedPriceBatch(requestParameters: ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeaturedOfferExpectedPriceBatchResponse>;
76
- };
77
- /**
78
- * Request parameters for getCompetitiveSummary operation in ProductPricingApi.
79
- */
80
- export interface ProductPricingApiGetCompetitiveSummaryRequest {
81
- /**
82
- * The batch of &#x60;getCompetitiveSummary&#x60; requests.
83
- */
84
- readonly requests: CompetitiveSummaryBatchRequest;
85
- }
86
- /**
87
- * Request parameters for getFeaturedOfferExpectedPriceBatch operation in ProductPricingApi.
88
- */
89
- export interface ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest {
90
- /**
91
- * The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
92
- */
93
- readonly getFeaturedOfferExpectedPriceBatchRequestBody: GetFeaturedOfferExpectedPriceBatchRequest;
94
- }
95
- /**
96
- * ProductPricingApi - object-oriented interface
97
- */
98
- export declare class ProductPricingApi extends BaseAPI {
99
- /**
100
- * Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
101
- * @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
102
- * @param {*} [options] Override http request option.
103
- * @throws {RequiredError}
104
- */
105
- getCompetitiveSummary(requestParameters: ProductPricingApiGetCompetitiveSummaryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CompetitiveSummaryBatchResponse, any, {}>>;
106
- /**
107
- * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed because competing offers might change. Other offers might be featured based on factors such as fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
108
- * @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
109
- * @param {*} [options] Override http request option.
110
- * @throws {RequiredError}
111
- */
112
- getFeaturedOfferExpectedPriceBatch(requestParameters: ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeaturedOfferExpectedPriceBatchResponse, any, {}>>;
113
- }
@@ -1,12 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export * from './api/product-pricing-api';
@@ -1,42 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from './configuration';
13
- import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- export declare const BASE_PATH: string;
15
- export declare const COLLECTION_FORMATS: {
16
- csv: string;
17
- ssv: string;
18
- tsv: string;
19
- pipes: string;
20
- };
21
- export interface RequestArgs {
22
- url: string;
23
- options: RawAxiosRequestConfig;
24
- }
25
- export declare class BaseAPI {
26
- protected basePath: string;
27
- protected axios: AxiosInstance;
28
- protected configuration: Configuration | undefined;
29
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
30
- }
31
- export declare class RequiredError extends Error {
32
- field: string;
33
- constructor(field: string, msg?: string);
34
- }
35
- interface ServerMap {
36
- [key: string]: {
37
- url: string;
38
- description: string;
39
- }[];
40
- }
41
- export declare const operationServerMap: ServerMap;
42
- export {};
@@ -1,34 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from "./configuration";
13
- import type { RequestArgs } from "./base";
14
- import type { AxiosInstance, AxiosResponse } from 'axios';
15
- export declare const DUMMY_BASE_URL = "https://example.com";
16
- /**
17
- *
18
- * @throws {RequiredError}
19
- */
20
- export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
21
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
22
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
23
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
24
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
25
- export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
26
- /**
27
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
30
- */
31
- export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
32
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
33
- export declare const toPathString: (url: URL) => string;
34
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -1,98 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- interface AWSv4Configuration {
13
- options?: {
14
- region?: string;
15
- service?: string;
16
- };
17
- credentials?: {
18
- accessKeyId?: string;
19
- secretAccessKey?: string;
20
- sessionToken?: string;
21
- };
22
- }
23
- export interface ConfigurationParameters {
24
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
- username?: string;
26
- password?: string;
27
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
- awsv4?: AWSv4Configuration;
29
- basePath?: string;
30
- serverIndex?: number;
31
- baseOptions?: any;
32
- formDataCtor?: new () => any;
33
- }
34
- export declare class Configuration {
35
- /**
36
- * parameter for apiKey security
37
- * @param name security name
38
- */
39
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
40
- /**
41
- * parameter for basic security
42
- */
43
- username?: string;
44
- /**
45
- * parameter for basic security
46
- */
47
- password?: string;
48
- /**
49
- * parameter for oauth2 security
50
- * @param name security name
51
- * @param scopes oauth2 scope
52
- */
53
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
- /**
55
- * parameter for aws4 signature security
56
- * @param {Object} AWS4Signature - AWS4 Signature security
57
- * @param {string} options.region - aws region
58
- * @param {string} options.service - name of the service.
59
- * @param {string} credentials.accessKeyId - aws access key id
60
- * @param {string} credentials.secretAccessKey - aws access key
61
- * @param {string} credentials.sessionToken - aws session token
62
- * @memberof Configuration
63
- */
64
- awsv4?: AWSv4Configuration;
65
- /**
66
- * override base path
67
- */
68
- basePath?: string;
69
- /**
70
- * override server index
71
- */
72
- serverIndex?: number;
73
- /**
74
- * base options for axios calls
75
- */
76
- baseOptions?: any;
77
- /**
78
- * The FormData constructor that will be used to create multipart form data
79
- * requests. You can inject this here so that execution environments that
80
- * do not support the FormData class can still run the generated client.
81
- *
82
- * @type {new () => FormData}
83
- */
84
- formDataCtor?: new () => any;
85
- constructor(param?: ConfigurationParameters);
86
- /**
87
- * Check if the given MIME is a JSON MIME.
88
- * JSON MIME examples:
89
- * application/json
90
- * application/json; charset=UTF8
91
- * APPLICATION/JSON
92
- * application/vnd.company+json
93
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
94
- * @return True if the given MIME is JSON, false otherwise.
95
- */
96
- isJsonMime(mime: string): boolean;
97
- }
98
- export {};
@@ -1,14 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export * from "./api";
13
- export * from "./configuration";
14
- export * from "./models";
@@ -1,34 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { HttpMethod } from './http-method';
13
- /**
14
- * The common properties for individual requests within a batch.
15
- */
16
- export interface BatchRequest {
17
- /**
18
- * The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this is `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`.
19
- */
20
- 'uri': string;
21
- 'method': HttpMethod;
22
- /**
23
- * Additional HTTP body information that is associated with an individual request within a batch.
24
- */
25
- 'body'?: {
26
- [key: string]: object;
27
- };
28
- /**
29
- * A mapping of additional HTTP headers to send or receive for an individual request within a batch.
30
- */
31
- 'headers'?: {
32
- [key: string]: string;
33
- };
34
- }
@@ -1,24 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { HttpStatusLine } from './http-status-line';
13
- /**
14
- * The common properties for responses to individual requests within a batch.
15
- */
16
- export interface BatchResponse {
17
- /**
18
- * A mapping of additional HTTP headers to send or receive for an individual request within a batch.
19
- */
20
- 'headers': {
21
- [key: string]: string;
22
- };
23
- 'status': HttpStatusLine;
24
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { CompetitiveSummaryRequest } from './competitive-summary-request';
13
- /**
14
- * The `competitiveSummary` batch request data.
15
- */
16
- export interface CompetitiveSummaryBatchRequest {
17
- /**
18
- * A batched list of `competitiveSummary` requests.
19
- */
20
- 'requests': Array<CompetitiveSummaryRequest>;
21
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { CompetitiveSummaryResponse } from './competitive-summary-response';
13
- /**
14
- * The response schema for the `competitiveSummaryBatch` operation.
15
- */
16
- export interface CompetitiveSummaryBatchResponse {
17
- /**
18
- * The response list for the `competitiveSummaryBatch` operation.
19
- */
20
- 'responses': Array<CompetitiveSummaryResponse>;
21
- }
@@ -1,20 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * The supported data types in the `getCompetitiveSummary` API.
14
- */
15
- export declare const CompetitiveSummaryIncludedData: {
16
- readonly FeaturedBuyingOptions: "featuredBuyingOptions";
17
- readonly ReferencePrices: "referencePrices";
18
- readonly LowestPricedOffers: "lowestPricedOffers";
19
- };
20
- export type CompetitiveSummaryIncludedData = typeof CompetitiveSummaryIncludedData[keyof typeof CompetitiveSummaryIncludedData];
@@ -1,40 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { CompetitiveSummaryIncludedData } from './competitive-summary-included-data';
13
- import type { HttpMethod } from './http-method';
14
- import type { LowestPricedOffersInput } from './lowest-priced-offers-input';
15
- /**
16
- * An individual `competitiveSummary` request for an ASIN and `marketplaceId`.
17
- */
18
- export interface CompetitiveSummaryRequest {
19
- /**
20
- * The ASIN of the item.
21
- */
22
- 'asin': string;
23
- /**
24
- * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
25
- */
26
- 'marketplaceId': string;
27
- /**
28
- * The list of requested competitive pricing data for the product.
29
- */
30
- 'includedData': Array<CompetitiveSummaryIncludedData>;
31
- /**
32
- * The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`
33
- */
34
- 'lowestPricedOffersInputs'?: Array<LowestPricedOffersInput>;
35
- 'method': HttpMethod;
36
- /**
37
- * The URI associated with the individual APIs that are called as part of the batch request.
38
- */
39
- 'uri': string;
40
- }
@@ -1,43 +0,0 @@
1
- /**
2
- * Selling Partner API for Pricing
3
- * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
- *
5
- * The version of the OpenAPI document: 2022-05-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { FeaturedBuyingOption } from './featured-buying-option';
13
- import type { LowestPricedOffer } from './lowest-priced-offer';
14
- import type { ReferencePrice } from './reference-price';
15
- /**
16
- * The `competitiveSummaryResponse` body for a requested ASIN and `marketplaceId`.
17
- */
18
- export interface CompetitiveSummaryResponseBody {
19
- /**
20
- * The ASIN of the item.
21
- */
22
- 'asin': string;
23
- /**
24
- * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
25
- */
26
- 'marketplaceId': string;
27
- /**
28
- * A list of featured buying options for the specified ASIN `marketplaceId` combination.
29
- */
30
- 'featuredBuyingOptions'?: Array<FeaturedBuyingOption>;
31
- /**
32
- * A list of lowest priced offers for the specified ASIN `marketplaceId` combination.
33
- */
34
- 'lowestPricedOffers'?: Array<LowestPricedOffer>;
35
- /**
36
- * A list of reference prices for the specified ASIN `marketplaceId` combination.
37
- */
38
- 'referencePrices'?: Array<ReferencePrice>;
39
- /**
40
- * A list of error responses that are returned when a request is unsuccessful.
41
- */
42
- 'errors'?: Array<Error>;
43
- }