@sp-api-sdk/solicitations-api-v1 1.10.8 → 1.10.10

package/dist/cjs/src/api-model/api/solicitations-api.js

@@ -139,23 +139,21 @@ const SolicitationsApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          * Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-         * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which a solicitation is sent.
-         * @param {Array<string>} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+         * @param {SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createProductReviewAndSellerFeedbackSolicitation(amazonOrderId, marketplaceIds, options) {
-            return localVarFp.createProductReviewAndSellerFeedbackSolicitation(amazonOrderId, marketplaceIds, options).then((request) => request(axios, basePath));
+        createProductReviewAndSellerFeedbackSolicitation(requestParameters, options) {
+            return localVarFp.createProductReviewAndSellerFeedbackSolicitation(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-         * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.
-         * @param {Array<string>} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+         * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSolicitationActionsForOrder(amazonOrderId, marketplaceIds, options) {
-            return localVarFp.getSolicitationActionsForOrder(amazonOrderId, marketplaceIds, options).then((request) => request(axios, basePath));
+        getSolicitationActionsForOrder(requestParameters, options) {
+            return localVarFp.getSolicitationActionsForOrder(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(axios, basePath));
         },
     };
 };

package/dist/cjs/src/api-model/base.js

@@ -15,8 +15,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const tslib_1 = require("tslib");
-// Some imports not used depending on template conditions
-// @ts-ignore
 const axios_1 = tslib_1.__importDefault(require("axios"));
 exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
 /**
@@ -57,10 +55,10 @@ exports.BaseAPI = BaseAPI;
  */
 class RequiredError extends Error {
     field;
-    name = "RequiredError";
     constructor(field, msg) {
         super(msg);
         this.field = field;
+        this.name = "RequiredError";
     }
 }
 exports.RequiredError = RequiredError;

package/dist/cjs/src/api-model/common.js

@@ -81,6 +81,8 @@ const setOAuthToObject = async function (object, name, scopes, configuration) {
 };
 exports.setOAuthToObject = setOAuthToObject;
 function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
     if (typeof parameter === "object") {
         if (Array.isArray(parameter)) {
             parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));

package/dist/es/src/api-model/api/solicitations-api.js

@@ -133,23 +133,21 @@ export const SolicitationsApiFactory = function (configuration, basePath, axios)
     return {
         /**
          * Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-         * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which a solicitation is sent.
-         * @param {Array<string>} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+         * @param {SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createProductReviewAndSellerFeedbackSolicitation(amazonOrderId, marketplaceIds, options) {
-            return localVarFp.createProductReviewAndSellerFeedbackSolicitation(amazonOrderId, marketplaceIds, options).then((request) => request(axios, basePath));
+        createProductReviewAndSellerFeedbackSolicitation(requestParameters, options) {
+            return localVarFp.createProductReviewAndSellerFeedbackSolicitation(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-         * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.
-         * @param {Array<string>} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+         * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSolicitationActionsForOrder(amazonOrderId, marketplaceIds, options) {
-            return localVarFp.getSolicitationActionsForOrder(amazonOrderId, marketplaceIds, options).then((request) => request(axios, basePath));
+        getSolicitationActionsForOrder(requestParameters, options) {
+            return localVarFp.getSolicitationActionsForOrder(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(axios, basePath));
         },
     };
 };

package/dist/es/src/api-model/base.js

@@ -11,8 +11,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-// Some imports not used depending on template conditions
-// @ts-ignore
 import globalAxios from 'axios';
 export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
 /**
@@ -52,9 +50,9 @@ export class BaseAPI {
  */
 export class RequiredError extends Error {
     field;
-    name = "RequiredError";
     constructor(field, msg) {
         super(msg);
         this.field = field;
+        this.name = "RequiredError";
     }
 }

package/dist/es/src/api-model/common.js

@@ -73,6 +73,8 @@ export const setOAuthToObject = async function (object, name, scopes, configurat
     }
 };
 function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
     if (typeof parameter === "object") {
         if (Array.isArray(parameter)) {
             parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));

package/dist/types/src/api-model/api/solicitations-api.d.ts

@@ -9,8 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
 import { CreateProductReviewAndSellerFeedbackSolicitationResponse } from '../models';
 import { GetSolicitationActionsForOrderResponse } from '../models';
@@ -65,20 +65,18 @@ export declare const SolicitationsApiFp: (configuration?: Configuration) => {
 export declare const SolicitationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      * Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-     * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which a solicitation is sent.
-     * @param {Array<string>} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+     * @param {SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createProductReviewAndSellerFeedbackSolicitation(amazonOrderId: string, marketplaceIds: Array<string>, options?: any): AxiosPromise<CreateProductReviewAndSellerFeedbackSolicitationResponse>;
+    createProductReviewAndSellerFeedbackSolicitation(requestParameters: SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateProductReviewAndSellerFeedbackSolicitationResponse>;
     /**
      * Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-     * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.
-     * @param {Array<string>} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+     * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSolicitationActionsForOrder(amazonOrderId: string, marketplaceIds: Array<string>, options?: any): AxiosPromise<GetSolicitationActionsForOrderResponse>;
+    getSolicitationActionsForOrder(requestParameters: SolicitationsApiGetSolicitationActionsForOrderRequest, options?: AxiosRequestConfig): AxiosPromise<GetSolicitationActionsForOrderResponse>;
 };
 /**
  * Request parameters for createProductReviewAndSellerFeedbackSolicitation operation in SolicitationsApi.

package/dist/types/src/api-model/base.d.ts

@@ -9,8 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { Configuration } from "./configuration";
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import type { Configuration } from './configuration';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
 /**
  *
@@ -50,6 +50,5 @@ export declare class BaseAPI {
  */
 export declare class RequiredError extends Error {
     field: string;
-    name: "RequiredError";
     constructor(field: string, msg?: string);
 }

package/dist/types/src/api-model/common.d.ts

@@ -10,9 +10,9 @@
  * Do not edit the class manually.
  */
 /// <reference types="node" />
-import { Configuration } from "./configuration";
-import { RequestArgs } from "./base";
-import { AxiosInstance, AxiosResponse } from 'axios';
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
 /**
  *
  * @export

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/solicitations-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get a list of solicitation types that are available for an order that you specify, then call an operation that sends a solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The Solicitations API returns responses that are formed according to the JSON Hypertext Application Language (HAL) standard.",
-  "version": "1.10.8",
+  "version": "1.10.10",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -26,7 +26,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@sp-api-sdk/common": "^1.9.20",
+    "@sp-api-sdk/common": "^1.9.22",
     "axios": "^0.27.2"
   },
   "repository": {
@@ -51,5 +51,5 @@
   "typedoc": {
     "entryPoint": "./index.ts"
   },
-  "gitHead": "e8ea8ef5b7745f2c4413bd7dd8eefa1b31cee128"
+  "gitHead": "19982f06cbbd770bfc7b9f1bc8a42f59b57baead"
 }