Package software.amazon.spapi.api.appintegrations.v2024_04_01

Class AppIntegrationsApi

  • public class AppIntegrationsApi
extends java.lang.Object

    • Field Detail

      • createNotificationBucket

        public final io.github.bucket4j.Bucket createNotificationBucket

      • deleteNotificationsBucket

        public final io.github.bucket4j.Bucket deleteNotificationsBucket

      • recordActionFeedbackBucket

        public final io.github.bucket4j.Bucket recordActionFeedbackBucket

    • Constructor Detail

      • AppIntegrationsApi

        public AppIntegrationsApi​(ApiClient apiClient,
                          java.lang.Boolean disableRateLimiting)

    • Method Detail

      • createNotification

        public CreateNotificationResponse createNotification​(CreateNotificationRequest body)
                                              throws ApiException,
                                                     LWAException
        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).
        Parameters:
        body - The request body for the `createNotification` operation. (required)
        Returns:
        CreateNotificationResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • createNotificationWithHttpInfo

        public ApiResponse<CreateNotificationResponse> createNotificationWithHttpInfo​(CreateNotificationRequest body)
                                                                       throws ApiException,
                                                                              LWAException
        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).
        Parameters:
        body - The request body for the `createNotification` operation. (required)
        Returns:
        ApiResponse<CreateNotificationResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • createNotificationAsync

        public okhttp3.Call createNotificationAsync​(CreateNotificationRequest body,
                                            ApiCallback<CreateNotificationResponse> callback)
                                     throws ApiException,
                                            LWAException
        (asynchronously) 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).
        Parameters:
        body - The request body for the `createNotification` operation. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • deleteNotifications

        public void deleteNotifications​(DeleteNotificationsRequest body)
                         throws ApiException,
                                LWAException
        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).
        Parameters:
        body - The request body for the `deleteNotifications` operation. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • deleteNotificationsWithHttpInfo

        public ApiResponse<java.lang.Void> deleteNotificationsWithHttpInfo​(DeleteNotificationsRequest body)
                                                            throws ApiException,
                                                                   LWAException
        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).
        Parameters:
        body - The request body for the `deleteNotifications` operation. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • deleteNotificationsAsync

        public okhttp3.Call deleteNotificationsAsync​(DeleteNotificationsRequest body,
                                             ApiCallback<java.lang.Void> callback)
                                      throws ApiException,
                                             LWAException
        (asynchronously) 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).
        Parameters:
        body - The request body for the `deleteNotifications` operation. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • recordActionFeedback

        public void recordActionFeedback​(RecordActionFeedbackRequest body,
                                 java.lang.String notificationId)
                          throws ApiException,
                                 LWAException
        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).
        Parameters:
        body - The request body for the `recordActionFeedback` operation. (required)
        notificationId - A `notificationId` uniquely identifies a notification. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • recordActionFeedbackWithHttpInfo

        public ApiResponse<java.lang.Void> recordActionFeedbackWithHttpInfo​(RecordActionFeedbackRequest body,
                                                                    java.lang.String notificationId)
                                                             throws ApiException,
                                                                    LWAException
        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).
        Parameters:
        body - The request body for the `recordActionFeedback` operation. (required)
        notificationId - A `notificationId` uniquely identifies a notification. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • recordActionFeedbackAsync

        public okhttp3.Call recordActionFeedbackAsync​(RecordActionFeedbackRequest body,
                                              java.lang.String notificationId,
                                              ApiCallback<java.lang.Void> callback)
                                       throws ApiException,
                                              LWAException
        (asynchronously) 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).
        Parameters:
        body - The request body for the `recordActionFeedback` operation. (required)
        notificationId - A `notificationId` uniquely identifies a notification. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails