@sp-api-sdk/product-pricing-api-2022-05-01 3.1.4 → 3.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 (67) hide show
  1. package/dist/cjs/api-model/api/product-pricing-api.js +0 -8
  2. package/dist/cjs/api-model/base.js +0 -19
  3. package/dist/cjs/api-model/common.js +0 -37
  4. package/dist/cjs/api-model/configuration.js +0 -17
  5. package/dist/cjs/api-model/models/competitive-summary-included-data.js +0 -2
  6. package/dist/cjs/api-model/models/condition.js +0 -2
  7. package/dist/cjs/api-model/models/featured-offer-segment.js +2 -1
  8. package/dist/cjs/api-model/models/fulfillment-type.js +0 -2
  9. package/dist/cjs/api-model/models/http-method.js +0 -2
  10. package/dist/cjs/api-model/models/lowest-priced-offers-input.js +1 -1
  11. package/dist/es/api-model/api/product-pricing-api.js +0 -8
  12. package/dist/es/api-model/base.js +0 -19
  13. package/dist/es/api-model/common.js +0 -37
  14. package/dist/es/api-model/configuration.js +0 -17
  15. package/dist/es/api-model/models/competitive-summary-included-data.js +0 -2
  16. package/dist/es/api-model/models/condition.js +0 -2
  17. package/dist/es/api-model/models/featured-offer-segment.js +2 -1
  18. package/dist/es/api-model/models/fulfillment-type.js +0 -2
  19. package/dist/es/api-model/models/http-method.js +0 -2
  20. package/dist/es/api-model/models/lowest-priced-offers-input.js +1 -1
  21. package/dist/types/api-model/api/product-pricing-api.d.ts +0 -16
  22. package/dist/types/api-model/base.d.ts +0 -24
  23. package/dist/types/api-model/common.d.ts +0 -37
  24. package/dist/types/api-model/configuration.d.ts +0 -17
  25. package/dist/types/api-model/models/batch-request.d.ts +0 -13
  26. package/dist/types/api-model/models/batch-response.d.ts +0 -9
  27. package/dist/types/api-model/models/competitive-summary-batch-request.d.ts +0 -4
  28. package/dist/types/api-model/models/competitive-summary-batch-response.d.ts +0 -4
  29. package/dist/types/api-model/models/competitive-summary-included-data.d.ts +0 -2
  30. package/dist/types/api-model/models/competitive-summary-request.d.ts +1 -18
  31. package/dist/types/api-model/models/competitive-summary-response-body.d.ts +1 -15
  32. package/dist/types/api-model/models/competitive-summary-response.d.ts +0 -12
  33. package/dist/types/api-model/models/condition.d.ts +0 -2
  34. package/dist/types/api-model/models/errors.d.ts +0 -4
  35. package/dist/types/api-model/models/featured-buying-option.d.ts +0 -6
  36. package/dist/types/api-model/models/featured-offer-expected-price-request-params.d.ts +1 -12
  37. package/dist/types/api-model/models/featured-offer-expected-price-request.d.ts +0 -1
  38. package/dist/types/api-model/models/featured-offer-expected-price-response-all-of.d.ts +0 -15
  39. package/dist/types/api-model/models/featured-offer-expected-price-response-body.d.ts +0 -11
  40. package/dist/types/api-model/models/featured-offer-expected-price-response.d.ts +0 -1
  41. package/dist/types/api-model/models/featured-offer-expected-price-result.d.ts +0 -19
  42. package/dist/types/api-model/models/featured-offer-expected-price.d.ts +0 -12
  43. package/dist/types/api-model/models/featured-offer-segment.d.ts +1 -9
  44. package/dist/types/api-model/models/featured-offer.d.ts +0 -17
  45. package/dist/types/api-model/models/fulfillment-type.d.ts +0 -2
  46. package/dist/types/api-model/models/get-featured-offer-expected-price-batch-request.d.ts +0 -4
  47. package/dist/types/api-model/models/get-featured-offer-expected-price-batch-response.d.ts +0 -4
  48. package/dist/types/api-model/models/http-method.d.ts +0 -2
  49. package/dist/types/api-model/models/http-status-line.d.ts +0 -6
  50. package/dist/types/api-model/models/lowest-priced-offer.d.ts +0 -9
  51. package/dist/types/api-model/models/lowest-priced-offers-input.d.ts +1 -10
  52. package/dist/types/api-model/models/model-error.d.ts +0 -8
  53. package/dist/types/api-model/models/money-type.d.ts +0 -6
  54. package/dist/types/api-model/models/offer-identifier.d.ts +1 -16
  55. package/dist/types/api-model/models/offer.d.ts +0 -33
  56. package/dist/types/api-model/models/points.d.ts +0 -9
  57. package/dist/types/api-model/models/postal-code.d.ts +0 -6
  58. package/dist/types/api-model/models/price.d.ts +0 -17
  59. package/dist/types/api-model/models/prime-details.d.ts +0 -4
  60. package/dist/types/api-model/models/reference-price.d.ts +1 -10
  61. package/dist/types/api-model/models/sample-location.d.ts +0 -7
  62. package/dist/types/api-model/models/segment-details.d.ts +0 -9
  63. package/dist/types/api-model/models/segment.d.ts +0 -7
  64. package/dist/types/api-model/models/segmented-featured-offer-all-of.d.ts +0 -4
  65. package/dist/types/api-model/models/segmented-featured-offer.d.ts +0 -1
  66. package/dist/types/api-model/models/shipping-option.d.ts +0 -9
  67. package/package.json +25 -4
@@ -11,8 +11,6 @@
11
11
  */
12
12
  /**
13
13
  * The HTTP method associated with an individual request within a batch.
14
- * @export
15
- * @enum {string}
16
14
  */
17
15
  export declare const HttpMethod: {
18
16
  readonly Get: "GET";
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * The HTTP status line associated with the response for an individual request within a batch. For more information, refer to [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html).
14
- * @export
15
- * @interface HttpStatusLine
16
14
  */
17
15
  export interface HttpStatusLine {
18
16
  /**
19
17
  * The HTTP response status code.
20
- * @type {number}
21
- * @memberof HttpStatusLine
22
18
  */
23
19
  'statusCode'?: number;
24
20
  /**
25
21
  * The HTTP response reason phrase.
26
- * @type {string}
27
- * @memberof HttpStatusLine
28
22
  */
29
23
  'reasonPhrase'?: string;
30
24
  }
@@ -13,20 +13,11 @@ import type { LowestPricedOffersInput } from './lowest-priced-offers-input';
13
13
  import type { Offer } from './offer';
14
14
  /**
15
15
  * Describes the lowest priced offers for the specified item condition and offer type.
16
- * @export
17
- * @interface LowestPricedOffer
18
16
  */
19
17
  export interface LowestPricedOffer {
20
- /**
21
- *
22
- * @type {LowestPricedOffersInput}
23
- * @memberof LowestPricedOffer
24
- */
25
18
  'lowestPricedOffersInput': LowestPricedOffersInput;
26
19
  /**
27
20
  * A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`.
28
- * @type {Array<Offer>}
29
- * @memberof LowestPricedOffer
30
21
  */
31
22
  'offers': Array<Offer>;
32
23
  }
@@ -12,24 +12,15 @@
12
12
  import type { Condition } from './condition';
13
13
  /**
14
14
  * The input required for building `LowestPricedOffers` data in the response.
15
- * @export
16
- * @interface LowestPricedOffersInput
17
15
  */
18
16
  export interface LowestPricedOffersInput {
19
- /**
20
- *
21
- * @type {Condition}
22
- * @memberof LowestPricedOffersInput
23
- */
24
17
  'itemCondition': Condition;
25
18
  /**
26
19
  * The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.
27
- * @type {string}
28
- * @memberof LowestPricedOffersInput
29
20
  */
30
21
  'offerType': LowestPricedOffersInputOfferTypeEnum;
31
22
  }
32
23
  export declare const LowestPricedOffersInputOfferTypeEnum: {
33
- readonly Consumer: "CONSUMER";
24
+ readonly Consumer: "Consumer";
34
25
  };
35
26
  export type LowestPricedOffersInputOfferTypeEnum = typeof LowestPricedOffersInputOfferTypeEnum[keyof typeof LowestPricedOffersInputOfferTypeEnum];
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * Error response returned when the request is unsuccessful.
14
- * @export
15
- * @interface ModelError
16
14
  */
17
15
  export interface ModelError {
18
16
  /**
19
17
  * An error code that identifies the type of error that occurred.
20
- * @type {string}
21
- * @memberof ModelError
22
18
  */
23
19
  'code': string;
24
20
  /**
25
21
  * A message that describes the error condition.
26
- * @type {string}
27
- * @memberof ModelError
28
22
  */
29
23
  'message': string;
30
24
  /**
31
25
  * Additional details that can help the caller understand or fix the issue.
32
- * @type {string}
33
- * @memberof ModelError
34
26
  */
35
27
  'details'?: string;
36
28
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * Currency type and monetary value schema to demonstrate pricing information.
14
- * @export
15
- * @interface MoneyType
16
14
  */
17
15
  export interface MoneyType {
18
16
  /**
19
17
  * The currency code in ISO 4217 format.
20
- * @type {string}
21
- * @memberof MoneyType
22
18
  */
23
19
  'currencyCode'?: string;
24
20
  /**
25
21
  * The monetary value.
26
- * @type {number}
27
- * @memberof MoneyType
28
22
  */
29
23
  'amount'?: number;
30
24
  }
@@ -12,38 +12,23 @@
12
12
  import type { FulfillmentType } from './fulfillment-type';
13
13
  /**
14
14
  * Identifies an offer from a particular seller for a specified ASIN.
15
- * @export
16
- * @interface OfferIdentifier
17
15
  */
18
16
  export interface OfferIdentifier {
19
17
  /**
20
- * A marketplace identifier. Specifies the marketplace for which data is returned.
21
- * @type {string}
22
- * @memberof OfferIdentifier
18
+ * 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).
23
19
  */
24
20
  'marketplaceId': string;
25
21
  /**
26
22
  * The seller identifier for the offer.
27
- * @type {string}
28
- * @memberof OfferIdentifier
29
23
  */
30
24
  'sellerId'?: string;
31
25
  /**
32
26
  * The seller SKU of the item. This will only be present for the target offer, which belongs to the requesting seller.
33
- * @type {string}
34
- * @memberof OfferIdentifier
35
27
  */
36
28
  'sku'?: string;
37
29
  /**
38
30
  * The ASIN of the item.
39
- * @type {string}
40
- * @memberof OfferIdentifier
41
31
  */
42
32
  'asin': string;
43
- /**
44
- *
45
- * @type {FulfillmentType}
46
- * @memberof OfferIdentifier
47
- */
48
33
  'fulfillmentType'?: FulfillmentType;
49
34
  }
@@ -17,57 +17,24 @@ import type { PrimeDetails } from './prime-details';
17
17
  import type { ShippingOption } from './shipping-option';
18
18
  /**
19
19
  * The offer data of a product.
20
- * @export
21
- * @interface Offer
22
20
  */
23
21
  export interface Offer {
24
22
  /**
25
23
  * The seller identifier for the offer.
26
- * @type {string}
27
- * @memberof Offer
28
24
  */
29
25
  'sellerId': string;
30
- /**
31
- *
32
- * @type {Condition}
33
- * @memberof Offer
34
- */
35
26
  'condition': Condition;
36
27
  /**
37
28
  * The item subcondition of the offer.
38
- * @type {string}
39
- * @memberof Offer
40
29
  */
41
30
  'subCondition'?: OfferSubConditionEnum;
42
- /**
43
- *
44
- * @type {FulfillmentType}
45
- * @memberof Offer
46
- */
47
31
  'fulfillmentType': FulfillmentType;
48
- /**
49
- *
50
- * @type {MoneyType}
51
- * @memberof Offer
52
- */
53
32
  'listingPrice': MoneyType;
54
33
  /**
55
34
  * A list of shipping options associated with this offer
56
- * @type {Array<ShippingOption>}
57
- * @memberof Offer
58
35
  */
59
36
  'shippingOptions'?: Array<ShippingOption>;
60
- /**
61
- *
62
- * @type {Points}
63
- * @memberof Offer
64
- */
65
37
  'points'?: Points;
66
- /**
67
- *
68
- * @type {PrimeDetails}
69
- * @memberof Offer
70
- */
71
38
  'primeDetails'?: PrimeDetails;
72
39
  }
73
40
  export declare const OfferSubConditionEnum: {
@@ -12,20 +12,11 @@
12
12
  import type { MoneyType } from './money-type';
13
13
  /**
14
14
  * The number of Amazon Points that are offered with the purchase of an item and the monetary value of these points.
15
- * @export
16
- * @interface Points
17
15
  */
18
16
  export interface Points {
19
17
  /**
20
18
  * The number of Amazon Points.
21
- * @type {number}
22
- * @memberof Points
23
19
  */
24
20
  'pointsNumber'?: number;
25
- /**
26
- *
27
- * @type {MoneyType}
28
- * @memberof Points
29
- */
30
21
  'pointsMonetaryValue'?: MoneyType;
31
22
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * Postal code value with country code
14
- * @export
15
- * @interface PostalCode
16
14
  */
17
15
  export interface PostalCode {
18
16
  /**
19
17
  * Country code value
20
- * @type {string}
21
- * @memberof PostalCode
22
18
  */
23
19
  'countryCode'?: string;
24
20
  /**
25
21
  * Postal code value
26
- * @type {string}
27
- * @memberof PostalCode
28
22
  */
29
23
  'value'?: string;
30
24
  }
@@ -13,26 +13,9 @@ import type { MoneyType } from './money-type';
13
13
  import type { Points } from './points';
14
14
  /**
15
15
  * The schema for item\'s price information, including listing price, shipping price, and Amazon Points.
16
- * @export
17
- * @interface Price
18
16
  */
19
17
  export interface Price {
20
- /**
21
- *
22
- * @type {MoneyType}
23
- * @memberof Price
24
- */
25
18
  'listingPrice': MoneyType;
26
- /**
27
- *
28
- * @type {MoneyType}
29
- * @memberof Price
30
- */
31
19
  'shippingPrice'?: MoneyType;
32
- /**
33
- *
34
- * @type {Points}
35
- * @memberof Price
36
- */
37
20
  'points'?: Points;
38
21
  }
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * Amazon Prime details.
14
- * @export
15
- * @interface PrimeDetails
16
14
  */
17
15
  export interface PrimeDetails {
18
16
  /**
19
17
  * Indicates whether the offer is an Amazon Prime offer.
20
- * @type {string}
21
- * @memberof PrimeDetails
22
18
  */
23
19
  'eligibility': PrimeDetailsEligibilityEnum;
24
20
  }
@@ -12,20 +12,11 @@
12
12
  import type { MoneyType } from './money-type';
13
13
  /**
14
14
  * The reference price for the specified ASIN `marketplaceId` combination.
15
- * @export
16
- * @interface ReferencePrice
17
15
  */
18
16
  export interface ReferencePrice {
19
17
  /**
20
- * The name of the reference price, such as `CompetitivePriceThreshold` and `WasPrice`. For reference price definitions, refer to the [Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
21
- * @type {string}
22
- * @memberof ReferencePrice
18
+ * Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, see the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
23
19
  */
24
20
  'name': string;
25
- /**
26
- *
27
- * @type {MoneyType}
28
- * @memberof ReferencePrice
29
- */
30
21
  'price': MoneyType;
31
22
  }
@@ -12,14 +12,7 @@
12
12
  import type { PostalCode } from './postal-code';
13
13
  /**
14
14
  * Information about a location. It uses a postal code to identify the location.
15
- * @export
16
- * @interface SampleLocation
17
15
  */
18
16
  export interface SampleLocation {
19
- /**
20
- *
21
- * @type {PostalCode}
22
- * @memberof SampleLocation
23
- */
24
17
  'postalCode'?: PostalCode;
25
18
  }
@@ -12,20 +12,11 @@
12
12
  import type { SampleLocation } from './sample-location';
13
13
  /**
14
14
  * The details about the segment. The FeaturedOfferExpectedPrice API uses only the sampleLocation portion as input.
15
- * @export
16
- * @interface SegmentDetails
17
15
  */
18
16
  export interface SegmentDetails {
19
17
  /**
20
18
  * The glance view weighted percentage for this segment, which is the glance views for this segment as a percentage of total glance views across all segments for the ASIN. A higher percentage indicates that more Amazon customers receive this offer as the Featured Offer.
21
- * @type {number}
22
- * @memberof SegmentDetails
23
19
  */
24
20
  'glanceViewWeightPercentage'?: number;
25
- /**
26
- *
27
- * @type {SampleLocation}
28
- * @memberof SegmentDetails
29
- */
30
21
  'sampleLocation'?: SampleLocation;
31
22
  }
@@ -12,14 +12,7 @@
12
12
  import type { SegmentDetails } from './segment-details';
13
13
  /**
14
14
  * Input segment for featured offer expected price. The segment contains the location information for which featured offer expected price is requested.
15
- * @export
16
- * @interface Segment
17
15
  */
18
16
  export interface Segment {
19
- /**
20
- *
21
- * @type {SegmentDetails}
22
- * @memberof Segment
23
- */
24
17
  'segmentDetails'?: SegmentDetails;
25
18
  }
@@ -12,14 +12,10 @@
12
12
  import type { FeaturedOfferSegment } from './featured-offer-segment';
13
13
  /**
14
14
  * The list of segment information in which the offer is featured.
15
- * @export
16
- * @interface SegmentedFeaturedOfferAllOf
17
15
  */
18
16
  export interface SegmentedFeaturedOfferAllOf {
19
17
  /**
20
18
  * The list of segment information in which the offer is featured.
21
- * @type {Array<FeaturedOfferSegment>}
22
- * @memberof SegmentedFeaturedOfferAllOf
23
19
  */
24
20
  'featuredOfferSegments': Array<FeaturedOfferSegment>;
25
21
  }
@@ -14,6 +14,5 @@ import type { SegmentedFeaturedOfferAllOf } from './segmented-featured-offer-all
14
14
  /**
15
15
  * @type SegmentedFeaturedOffer
16
16
  * A product offer with segment information indicating where it\'s featured.
17
- * @export
18
17
  */
19
18
  export type SegmentedFeaturedOffer = Offer & SegmentedFeaturedOfferAllOf;
@@ -12,21 +12,12 @@
12
12
  import type { MoneyType } from './money-type';
13
13
  /**
14
14
  * The shipping option available for the offer.
15
- * @export
16
- * @interface ShippingOption
17
15
  */
18
16
  export interface ShippingOption {
19
17
  /**
20
18
  * The type of shipping option.
21
- * @type {string}
22
- * @memberof ShippingOption
23
19
  */
24
20
  'shippingOptionType': ShippingOptionShippingOptionTypeEnum;
25
- /**
26
- *
27
- * @type {MoneyType}
28
- * @memberof ShippingOption
29
- */
30
21
  'price': MoneyType;
31
22
  }
32
23
  export declare const ShippingOptionShippingOptionTypeEnum: {
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/product-pricing-api-2022-05-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "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.",
5
- "version": "3.1.4",
5
+ "version": "3.2.1",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.14",
22
- "axios": "^1.9.0"
21
+ "@sp-api-sdk/common": "2.1.16",
22
+ "axios": "^1.11.0"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,26 @@
40
40
  "sp sdk",
41
41
  "product pricing api"
42
42
  ],
43
- "gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
43
+ "xo": {
44
+ "extends": [
45
+ "xo-bizon"
46
+ ],
47
+ "settings": {
48
+ "import/internal-regex": "^@sp-api-sdk/"
49
+ },
50
+ "semicolon": false,
51
+ "space": 2,
52
+ "prettier": true,
53
+ "ignores": [
54
+ "src/api-model/**"
55
+ ],
56
+ "rules": {
57
+ "unicorn/prevent-abbreviations": "off"
58
+ }
59
+ },
60
+ "prettier": {
61
+ "printWidth": 100,
62
+ "jsxSingleQuote": true
63
+ },
64
+ "gitHead": "fc1b46f3bc172469e2fbbc2e0155f6fa7ce3edde"
44
65
  }