/** * The Selling Partner API for third party application integrations. * With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central. * * The version of the OpenAPI document: 2024-04-01 * * * 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 request for the `createNotification` operation. * @export * @interface CreateNotificationRequest */ export interface CreateNotificationRequest { /** * The unique identifier of the notification template you used to onboard your application. * @type {string} * @memberof CreateNotificationRequest */ templateId: string; /** * The dynamic parameters required by the notification templated specified by `templateId`. * @type {{ [key: string]: object; }} * @memberof CreateNotificationRequest */ notificationParameters: { [key: string]: object; }; /** * An encrypted marketplace identifier for the posted notification. * @type {string} * @memberof CreateNotificationRequest */ marketplaceId?: string; } /** * The response for the `createNotification` operation. * @export * @interface CreateNotificationResponse */ export interface CreateNotificationResponse { /** * The unique identifier assigned to each notification. * @type {string} * @memberof CreateNotificationResponse */ notificationId?: string; } /** * The request for the `deleteNotifications` operation. * @export * @interface DeleteNotificationsRequest */ export interface DeleteNotificationsRequest { /** * The unique identifier of the notification template you used to onboard your application. * @type {string} * @memberof DeleteNotificationsRequest */ templateId: string; /** * The unique identifier that maps each notification status to a reason code. * @type {string} * @memberof DeleteNotificationsRequest */ deletionReason: DeleteNotificationsRequestDeletionReasonEnum | 'INCORRECT_CONTENT' | 'INCORRECT_RECIPIENT'; } /** * @export * @enum {string} */ export declare enum DeleteNotificationsRequestDeletionReasonEnum { Content = "INCORRECT_CONTENT", Recipient = "INCORRECT_RECIPIENT" } /** * A list of error responses returned when a request is unsuccessful. * @export * @interface ErrorList */ export interface ErrorList { /** * Error response returned when the request is unsuccessful. * @type {Array} * @memberof ErrorList */ errors: Array; } /** * 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. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * The request for the `recordActionFeedback` operation. * @export * @interface RecordActionFeedbackRequest */ export interface RecordActionFeedbackRequest { /** * The unique identifier for each notification status. * @type {string} * @memberof RecordActionFeedbackRequest */ feedbackActionCode: RecordActionFeedbackRequestFeedbackActionCodeEnum | 'SELLER_ACTION_COMPLETED'; } /** * @export * @enum {string} */ export declare enum RecordActionFeedbackRequestFeedbackActionCodeEnum { SellerActionCompleted = "SELLER_ACTION_COMPLETED" } /** * AppIntegrationsApi - axios parameter creator * @export */ export declare const AppIntegrationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {CreateNotificationRequest} body The request body for the `createNotification` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNotification: (body: CreateNotificationRequest, options?: any) => Promise; /** * Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {DeleteNotificationsRequest} body The request body for the `deleteNotifications` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNotifications: (body: DeleteNotificationsRequest, options?: any) => Promise; /** * Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} notificationId A `notificationId` uniquely identifies a notification. * @param {RecordActionFeedbackRequest} body The request body for the `recordActionFeedback` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ recordActionFeedback: (notificationId: string, body: RecordActionFeedbackRequest, options?: any) => Promise; }; /** * AppIntegrationsApi - functional programming interface * @export */ export declare const AppIntegrationsApiFp: (configuration?: Configuration) => { /** * Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {CreateNotificationRequest} body The request body for the `createNotification` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNotification(body: CreateNotificationRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {DeleteNotificationsRequest} body The request body for the `deleteNotifications` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNotifications(body: DeleteNotificationsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} notificationId A `notificationId` uniquely identifies a notification. * @param {RecordActionFeedbackRequest} body The request body for the `recordActionFeedback` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ recordActionFeedback(notificationId: string, body: RecordActionFeedbackRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AppIntegrationsApi - factory interface * @export */ export declare const AppIntegrationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {CreateNotificationRequest} body The request body for the `createNotification` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNotification(body: CreateNotificationRequest, options?: any): AxiosPromise; /** * Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {DeleteNotificationsRequest} body The request body for the `deleteNotifications` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNotifications(body: DeleteNotificationsRequest, options?: any): AxiosPromise; /** * Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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} notificationId A `notificationId` uniquely identifies a notification. * @param {RecordActionFeedbackRequest} body The request body for the `recordActionFeedback` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ recordActionFeedback(notificationId: string, body: RecordActionFeedbackRequest, options?: any): AxiosPromise; }; /** * Request parameters for createNotification operation in AppIntegrationsApi. * @export * @interface AppIntegrationsApiCreateNotificationRequest */ export interface AppIntegrationsApiCreateNotificationRequest { /** * The request body for the `createNotification` operation. * @type {CreateNotificationRequest} * @memberof AppIntegrationsApiCreateNotification */ readonly body: CreateNotificationRequest; } /** * Request parameters for deleteNotifications operation in AppIntegrationsApi. * @export * @interface AppIntegrationsApiDeleteNotificationsRequest */ export interface AppIntegrationsApiDeleteNotificationsRequest { /** * The request body for the `deleteNotifications` operation. * @type {DeleteNotificationsRequest} * @memberof AppIntegrationsApiDeleteNotifications */ readonly body: DeleteNotificationsRequest; } /** * Request parameters for recordActionFeedback operation in AppIntegrationsApi. * @export * @interface AppIntegrationsApiRecordActionFeedbackRequest */ export interface AppIntegrationsApiRecordActionFeedbackRequest { /** * A `notificationId` uniquely identifies a notification. * @type {string} * @memberof AppIntegrationsApiRecordActionFeedback */ readonly notificationId: string; /** * The request body for the `recordActionFeedback` operation. * @type {RecordActionFeedbackRequest} * @memberof AppIntegrationsApiRecordActionFeedback */ readonly body: RecordActionFeedbackRequest; } /** * AppIntegrationsApi - object-oriented interface * @export * @class AppIntegrationsApi * @extends {BaseAPI} */ export declare class AppIntegrationsApi extends BaseAPI { /** * Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {AppIntegrationsApiCreateNotificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AppIntegrationsApi */ createNotification(requestParameters: AppIntegrationsApiCreateNotificationRequest, options?: any): Promise>; /** * Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {AppIntegrationsApiDeleteNotificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AppIntegrationsApi */ deleteNotifications(requestParameters: AppIntegrationsApiDeleteNotificationsRequest, options?: any): Promise>; /** * Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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 {AppIntegrationsApiRecordActionFeedbackRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AppIntegrationsApi */ recordActionFeedback(requestParameters: AppIntegrationsApiRecordActionFeedbackRequest, options?: any): Promise>; }