/** * Selling Partner API for Solicitations * 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. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * The response schema for the createProductReviewAndSellerFeedbackSolicitation operation. * @export * @interface CreateProductReviewAndSellerFeedbackSolicitationResponse */ export interface CreateProductReviewAndSellerFeedbackSolicitationResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateProductReviewAndSellerFeedbackSolicitationResponse */ errors?: Array; } /** * * @export * @interface GetSchemaResponse */ export interface GetSchemaResponse { /** * * @type {GetSchemaResponseLinks} * @memberof GetSchemaResponse */ _links?: GetSchemaResponseLinks; /** * A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema. * @type {{ [key: string]: object; }} * @memberof GetSchemaResponse */ payload?: { [key: string]: object; }; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetSchemaResponse */ errors?: Array; } /** * * @export * @interface GetSchemaResponseLinks */ export interface GetSchemaResponseLinks { /** * * @type {LinkObject} * @memberof GetSchemaResponseLinks */ self: LinkObject; } /** * Describes a solicitation action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input. * @export * @interface GetSolicitationActionResponse */ export interface GetSolicitationActionResponse { /** * * @type {GetSolicitationActionResponseLinks} * @memberof GetSolicitationActionResponse */ _links?: GetSolicitationActionResponseLinks; /** * * @type {GetSolicitationActionResponseEmbedded} * @memberof GetSolicitationActionResponse */ _embedded?: GetSolicitationActionResponseEmbedded; /** * * @type {SolicitationsAction} * @memberof GetSolicitationActionResponse */ payload?: SolicitationsAction; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetSolicitationActionResponse */ errors?: Array; } /** * * @export * @interface GetSolicitationActionResponseEmbedded */ export interface GetSolicitationActionResponseEmbedded { /** * * @type {GetSchemaResponse} * @memberof GetSolicitationActionResponseEmbedded */ schema?: GetSchemaResponse; } /** * * @export * @interface GetSolicitationActionResponseLinks */ export interface GetSolicitationActionResponseLinks { /** * * @type {LinkObject} * @memberof GetSolicitationActionResponseLinks */ self: LinkObject; /** * * @type {LinkObject} * @memberof GetSolicitationActionResponseLinks */ schema: LinkObject; } /** * The response schema for the getSolicitationActionsForOrder operation. * @export * @interface GetSolicitationActionsForOrderResponse */ export interface GetSolicitationActionsForOrderResponse { /** * * @type {GetSolicitationActionsForOrderResponseLinks} * @memberof GetSolicitationActionsForOrderResponse */ _links?: GetSolicitationActionsForOrderResponseLinks; /** * * @type {GetSolicitationActionsForOrderResponseEmbedded} * @memberof GetSolicitationActionsForOrderResponse */ _embedded?: GetSolicitationActionsForOrderResponseEmbedded; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetSolicitationActionsForOrderResponse */ errors?: Array; } /** * * @export * @interface GetSolicitationActionsForOrderResponseEmbedded */ export interface GetSolicitationActionsForOrderResponseEmbedded { /** * * @type {Array} * @memberof GetSolicitationActionsForOrderResponseEmbedded */ actions: Array; } /** * * @export * @interface GetSolicitationActionsForOrderResponseLinks */ export interface GetSolicitationActionsForOrderResponseLinks { /** * * @type {LinkObject} * @memberof GetSolicitationActionsForOrderResponseLinks */ self: LinkObject; /** * Eligible actions for the specified amazonOrderId. * @type {Array} * @memberof GetSolicitationActionsForOrderResponseLinks */ actions: Array; } /** * A Link object. * @export * @interface LinkObject */ export interface LinkObject { /** * A URI for this object. * @type {string} * @memberof LinkObject */ href: string; /** * An identifier for this object. * @type {string} * @memberof LinkObject */ name?: string; } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition in a human-readable form. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * A simple object containing the name of the template. * @export * @interface SolicitationsAction */ export interface SolicitationsAction { /** * * @type {string} * @memberof SolicitationsAction */ name: string; } /** * SolicitationsApi - axios parameter creator * @export */ export declare const SolicitationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which a solicitation is sent. * @param {Array} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProductReviewAndSellerFeedbackSolicitation: (amazonOrderId: string, marketplaceIds: Array, options?: any) => Promise; /** * 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. * @param {Array} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSolicitationActionsForOrder: (amazonOrderId: string, marketplaceIds: Array, options?: any) => Promise; }; /** * SolicitationsApi - functional programming interface * @export */ export declare const SolicitationsApiFp: (configuration?: Configuration) => { /** * 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which a solicitation is sent. * @param {Array} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProductReviewAndSellerFeedbackSolicitation(amazonOrderId: string, marketplaceIds: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. * @param {Array} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSolicitationActionsForOrder(amazonOrderId: string, marketplaceIds: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SolicitationsApi - factory interface * @export */ 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which a solicitation is sent. * @param {Array} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProductReviewAndSellerFeedbackSolicitation(amazonOrderId: string, marketplaceIds: Array, options?: any): AxiosPromise; /** * 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. * @param {Array} marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSolicitationActionsForOrder(amazonOrderId: string, marketplaceIds: Array, options?: any): AxiosPromise; }; /** * Request parameters for createProductReviewAndSellerFeedbackSolicitation operation in SolicitationsApi. * @export * @interface SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest */ export interface SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest { /** * An Amazon order identifier. This specifies the order for which a solicitation is sent. * @type {string} * @memberof SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitation */ readonly amazonOrderId: string; /** * A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @type {Array} * @memberof SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitation */ readonly marketplaceIds: Array; } /** * Request parameters for getSolicitationActionsForOrder operation in SolicitationsApi. * @export * @interface SolicitationsApiGetSolicitationActionsForOrderRequest */ export interface SolicitationsApiGetSolicitationActionsForOrderRequest { /** * An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. * @type {string} * @memberof SolicitationsApiGetSolicitationActionsForOrder */ readonly amazonOrderId: string; /** * A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. * @type {Array} * @memberof SolicitationsApiGetSolicitationActionsForOrder */ readonly marketplaceIds: Array; } /** * SolicitationsApi - object-oriented interface * @export * @class SolicitationsApi * @extends {BaseAPI} */ export declare class SolicitationsApi extends BaseAPI { /** * 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SolicitationsApi */ createProductReviewAndSellerFeedbackSolicitation(requestParameters: SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest, options?: any): Promise>; /** * 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 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SolicitationsApi */ getSolicitationActionsForOrder(requestParameters: SolicitationsApiGetSolicitationActionsForOrderRequest, options?: any): Promise>; }