feat(clients): update models as of 2025-05-29 (#1507)

bizon-bot · tusbar · web-flow · commit 362c6e180e39 · 2025-05-30T09:33:39.000+02:00
Co-authored-by: tusbar &lt;166147+tusbar@users.noreply.github.com&gt;
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/api/listings-items-api.ts b/clients/listings-items-api-2021-08-01/src/api-model/api/listings-items-api.ts
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/models/fulfillment-availability.ts b/clients/listings-items-api-2021-08-01/src/api-model/models/fulfillment-availability.ts
@@ -21,7 +21,7 @@
  */
 export interface FulfillmentAvailability {
     /**
-     * The code of the fulfillment network that will be used.
+     * Designates which fulfillment network is used.
      * @type {string}
      * @memberof FulfillmentAvailability
      */
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/models/issue-exemption.ts b/clients/listings-items-api-2021-08-01/src/api-model/models/issue-exemption.ts
@@ -27,7 +27,7 @@ export interface IssueExemption {
      */
     'status': IssueExemptionStatusEnum;
     /**
-     * This field represents the timestamp, following the ISO 8601 format, which specifies the date when temporary exemptions, if applicable, will expire, and Amazon will begin enforcing the listed actions.
+     * Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions.
      * @type {string}
      * @memberof IssueExemption
      */
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/models/issue.ts b/clients/listings-items-api-2021-08-01/src/api-model/models/issue.ts
@@ -48,7 +48,7 @@ export interface Issue {
      */
     'attributeNames'?: Array<string>;
     /**
-     * List of issue categories.   Possible vales:   * `INVALID_ATTRIBUTE` - Indicating an invalid attribute in the listing.   * `MISSING_ATTRIBUTE` - Highlighting a missing attribute in the listing.   * `INVALID_IMAGE` - Signifying an invalid image in the listing.   * `MISSING_IMAGE` - Noting the absence of an image in the listing.   * `INVALID_PRICE` - Pertaining to issues with the listing\'s price-related attributes.   * `MISSING_PRICE` - Pointing out the absence of a price attribute in the listing.   * `DUPLICATE` - Identifying listings with potential duplicate problems, such as this ASIN potentially being a duplicate of another ASIN.   * `QUALIFICATION_REQUIRED` - Indicating that the listing requires qualification-related approval.
+     * List of issue categories.   Possible values:   * \'INVALID_ATTRIBUTE\' - Indicating an invalid attribute in the listing.   * \'MISSING_ATTRIBUTE\' - Highlighting a missing attribute in the listing.   * \'INVALID_IMAGE\' - Signifying an invalid image in the listing.   * \'MISSING_IMAGE\' - Noting the absence of an image in the listing.   * \'INVALID_PRICE\' - Pertaining to issues with the listing\'s price-related attributes.   * \'MISSING_PRICE\' - Pointing out the absence of a price attribute in the listing.   * \'DUPLICATE\' - Identifying listings with potential duplicate problems, such as this ASIN potentially being a duplicate of another ASIN.   * \'QUALIFICATION_REQUIRED\' - Indicating that the listing requires qualification-related approval.
      * @type {Array<string>}
      * @memberof Issue
      */
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/models/item-relationship.ts b/clients/listings-items-api-2021-08-01/src/api-model/models/item-relationship.ts
@@ -18,7 +18,7 @@
 import type { ItemVariationTheme } from './item-variation-theme';
 
 /**
- * the relationship details for a listing item.
+ * The relationship details for a listing item.
  * @export
  * @interface ItemRelationship
  */
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/models/item-search-results.ts b/clients/listings-items-api-2021-08-01/src/api-model/models/item-search-results.ts
@@ -27,7 +27,7 @@ import type { Pagination } from './pagination';
  */
 export interface ItemSearchResults {
     /**
-     * The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found).  Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.
+     * The total number of selling partner listings items found for the search criteria (only results up to the page count limit is returned per request regardless of the number found).  Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.
      * @type {number}
      * @memberof ItemSearchResults
      */
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/models/pagination.ts b/clients/listings-items-api-2021-08-01/src/api-model/models/pagination.ts
@@ -15,7 +15,7 @@
 
 
 /**
- * When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object.
+ * When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there is no `nextToken` key in the pagination object.
  * @export
  * @interface Pagination
  */
diff --git a/clients/listings-items-api-2021-08-01/src/api-model/models/patch-operation.ts b/clients/listings-items-api-2021-08-01/src/api-model/models/patch-operation.ts
@@ -21,7 +21,7 @@
  */
 export interface PatchOperation {
     /**
-     * Type of JSON Patch operation. Supported JSON Patch operations include add, replace, and delete. Refer to [JavaScript Object Notation (JSON) Patch](https://tools.ietf.org/html/rfc6902) for more information.
+     * Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`, `merge` and `delete`. Refer to <https://tools.ietf.org/html/rfc6902>.
      * @type {string}
      * @memberof PatchOperation
      */
@@ -33,7 +33,7 @@ export interface PatchOperation {
      */
     'path': string;
     /**
-     * JSON value to add, replace, or delete.
+     * JSON value to `add`, `replace`, `merge` or `delete`.
      * @type {Array<{ [key: string]: any; }>}
      * @memberof PatchOperation
      */
@@ -43,6 +43,7 @@ export interface PatchOperation {
 export const PatchOperationOpEnum = {
     Add: 'add',
     Replace: 'replace',
+    Merge: 'merge',
     Delete: 'delete'
 } as const;
 
diff --git a/clients/product-pricing-api-2022-05-01/src/api-model/models/competitive-summary-request.ts b/clients/product-pricing-api-2022-05-01/src/api-model/models/competitive-summary-request.ts
@@ -36,7 +36,7 @@ export interface CompetitiveSummaryRequest {
      */
     'asin': string;
     /**
-     * A marketplace identifier. Specifies the marketplace for which data is returned.
+     * 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).
      * @type {string}
      * @memberof CompetitiveSummaryRequest
      */
diff --git a/clients/product-pricing-api-2022-05-01/src/api-model/models/competitive-summary-response-body.ts b/clients/product-pricing-api-2022-05-01/src/api-model/models/competitive-summary-response-body.ts
@@ -36,7 +36,7 @@ export interface CompetitiveSummaryResponseBody {
      */
     'asin': string;
     /**
-     * A marketplace identifier. Specifies the marketplace for which data is returned.
+     * 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).
      * @type {string}
      * @memberof CompetitiveSummaryResponseBody
      */
diff --git a/clients/product-pricing-api-2022-05-01/src/api-model/models/featured-offer-expected-price-request-params.ts b/clients/product-pricing-api-2022-05-01/src/api-model/models/featured-offer-expected-price-request-params.ts
@@ -24,7 +24,7 @@ import type { Segment } from './segment';
  */
 export interface FeaturedOfferExpectedPriceRequestParams {
     /**
-     * A marketplace identifier. Specifies the marketplace for which data is returned.
+     * 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).
      * @type {string}
      * @memberof FeaturedOfferExpectedPriceRequestParams
      */
diff --git a/clients/product-pricing-api-2022-05-01/src/api-model/models/featured-offer-segment.ts b/clients/product-pricing-api-2022-05-01/src/api-model/models/featured-offer-segment.ts
@@ -39,7 +39,8 @@ export interface FeaturedOfferSegment {
 
 export const FeaturedOfferSegmentCustomerMembershipEnum = {
     Prime: 'PRIME',
-    NonPrime: 'NON_PRIME'
+    NonPrime: 'NON_PRIME',
+    Default: 'DEFAULT'
 } as const;
 
 export type FeaturedOfferSegmentCustomerMembershipEnum = typeof FeaturedOfferSegmentCustomerMembershipEnum[keyof typeof FeaturedOfferSegmentCustomerMembershipEnum];
diff --git a/clients/product-pricing-api-2022-05-01/src/api-model/models/lowest-priced-offers-input.ts b/clients/product-pricing-api-2022-05-01/src/api-model/models/lowest-priced-offers-input.ts
@@ -38,7 +38,7 @@ export interface LowestPricedOffersInput {
 }
 
 export const LowestPricedOffersInputOfferTypeEnum = {
-    Consumer: 'CONSUMER'
+    Consumer: 'Consumer'
 } as const;
 
 export type LowestPricedOffersInputOfferTypeEnum = typeof LowestPricedOffersInputOfferTypeEnum[keyof typeof LowestPricedOffersInputOfferTypeEnum];
diff --git a/clients/product-pricing-api-2022-05-01/src/api-model/models/offer-identifier.ts b/clients/product-pricing-api-2022-05-01/src/api-model/models/offer-identifier.ts
@@ -24,7 +24,7 @@ import type { FulfillmentType } from './fulfillment-type';
  */
 export interface OfferIdentifier {
     /**
-     * A marketplace identifier. Specifies the marketplace for which data is returned.
+     * 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).
      * @type {string}
      * @memberof OfferIdentifier
      */
diff --git a/clients/sales-api-v1/src/api-model/api/sales-api.ts b/clients/sales-api-v1/src/api-model/api/sales-api.ts
@@ -40,10 +40,11 @@ export const SalesApiAxiosParamCreator = function (configuration?: Configuration
          * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity&#x3D;Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
          * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
          * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+         * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** &#x60;AmazonHaul&#x60; returns order metrics for the Amazon Haul program only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrderMetrics: async (marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getOrderMetrics: async (marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, amazonProgram?: GetOrderMetricsAmazonProgramEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'marketplaceIds' is not null or undefined
             assertParamExists('getOrderMetrics', 'marketplaceIds', marketplaceIds)
             // verify required parameter 'interval' is not null or undefined
@@ -98,6 +99,10 @@ export const SalesApiAxiosParamCreator = function (configuration?: Configuration
                 localVarQueryParameter['sku'] = sku;
             }
 
+            if (amazonProgram !== undefined) {
+                localVarQueryParameter['amazonProgram'] = amazonProgram;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -130,11 +135,12 @@ export const SalesApiFp = function(configuration?: Configuration) {
          * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity&#x3D;Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
          * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
          * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+         * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** &#x60;AmazonHaul&#x60; returns order metrics for the Amazon Haul program only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getOrderMetrics(marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderMetricsResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, options);
+        async getOrderMetrics(marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, amazonProgram?: GetOrderMetricsAmazonProgramEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderMetricsResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, amazonProgram, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SalesApi.getOrderMetrics']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -156,7 +162,7 @@ export const SalesApiFactory = function (configuration?: Configuration, basePath
          * @throws {RequiredError}
          */
         getOrderMetrics(requestParameters: SalesApiGetOrderMetricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderMetricsResponse> {
-            return localVarFp.getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, options).then((request) => request(axios, basePath));
+            return localVarFp.getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -229,6 +235,13 @@ export interface SalesApiGetOrderMetricsRequest {
      * @memberof SalesApiGetOrderMetrics
      */
     readonly sku?: string
+
+    /**
+     * Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** &#x60;AmazonHaul&#x60; returns order metrics for the Amazon Haul program only.
+     * @type {'AmazonHaul'}
+     * @memberof SalesApiGetOrderMetrics
+     */
+    readonly amazonProgram?: GetOrderMetricsAmazonProgramEnum
 }
 
 /**
@@ -246,7 +259,7 @@ export class SalesApi extends BaseAPI {
      * @memberof SalesApi
      */
     public getOrderMetrics(requestParameters: SalesApiGetOrderMetricsRequest, options?: RawAxiosRequestConfig) {
-        return SalesApiFp(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, options).then((request) => request(this.axios, this.basePath));
+        return SalesApiFp(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(this.axios, this.basePath));
     }
 }
 
@@ -279,3 +292,10 @@ export const GetOrderMetricsFirstDayOfWeekEnum = {
     Sunday: 'Sunday'
 } as const;
 export type GetOrderMetricsFirstDayOfWeekEnum = typeof GetOrderMetricsFirstDayOfWeekEnum[keyof typeof GetOrderMetricsFirstDayOfWeekEnum];
+/**
+ * @export
+ */
+export const GetOrderMetricsAmazonProgramEnum = {
+    AmazonHaul: 'AmazonHaul'
+} as const;
+export type GetOrderMetricsAmazonProgramEnum = typeof GetOrderMetricsAmazonProgramEnum[keyof typeof GetOrderMetricsAmazonProgramEnum];
