@sp-api-sdk/application-integrations-api-2024-04-01 3.0.16 → 4.0.0

package/dist/index.d.ts

@@ -0,0 +1,426 @@
+import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import * as axios from 'axios';
+import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
+
+/**
+ * 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.
+ */
+interface AWSv4Configuration {
+    options?: {
+        region?: string;
+        service?: string;
+    };
+    credentials?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        sessionToken?: string;
+    };
+}
+interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
+     * @memberof Configuration
+     */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
+    basePath?: string;
+    /**
+     * override server index
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+
+/**
+ * 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.
+ */
+
+interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+
+/**
+ * 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.
+ */
+/**
+ * The request for the `createNotification` operation.
+ */
+interface CreateNotificationRequest {
+    /**
+     * The unique identifier of the notification template you used to onboard your application.
+     */
+    'templateId': string;
+    /**
+     * The dynamic parameters required by the notification templated specified by `templateId`.
+     */
+    'notificationParameters': {
+        [key: string]: object;
+    };
+    /**
+     * An encrypted marketplace identifier for the posted notification.
+     */
+    'marketplaceId'?: string;
+}
+
+/**
+ * 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.
+ */
+/**
+ * The response for the `createNotification` operation.
+ */
+interface CreateNotificationResponse {
+    /**
+     * The unique identifier assigned to each notification.
+     */
+    'notificationId'?: string;
+}
+
+/**
+ * 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.
+ */
+/**
+ * The request for the `deleteNotifications` operation.
+ */
+interface DeleteNotificationsRequest {
+    /**
+     * The unique identifier of the notification template you used to onboard your application.
+     */
+    'templateId': string;
+    /**
+     * The unique identifier that maps each notification status to a reason code.
+     */
+    'deletionReason': DeleteNotificationsRequestDeletionReasonEnum;
+}
+declare const DeleteNotificationsRequestDeletionReasonEnum: {
+    readonly IncorrectContent: "INCORRECT_CONTENT";
+    readonly IncorrectRecipient: "INCORRECT_RECIPIENT";
+};
+type DeleteNotificationsRequestDeletionReasonEnum = typeof DeleteNotificationsRequestDeletionReasonEnum[keyof typeof DeleteNotificationsRequestDeletionReasonEnum];
+
+/**
+ * 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.
+ */
+/**
+ * A list of error responses returned when a request is unsuccessful.
+ */
+interface ErrorList {
+    /**
+     * Error response returned when the request is unsuccessful.
+     */
+    'errors': Array<Error>;
+}
+
+/**
+ * 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.
+ */
+/**
+ * Error response returned when the request is unsuccessful.
+ */
+interface ModelError {
+    /**
+     * An error code that identifies the type of error that occurred.
+     */
+    'code': string;
+    /**
+     * A message that describes the error condition.
+     */
+    'message': string;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     */
+    'details'?: string;
+}
+
+/**
+ * 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.
+ */
+/**
+ * The request for the `recordActionFeedback` operation.
+ */
+interface RecordActionFeedbackRequest {
+    /**
+     * The unique identifier for each notification status.
+     */
+    'feedbackActionCode': RecordActionFeedbackRequestFeedbackActionCodeEnum;
+}
+declare const RecordActionFeedbackRequestFeedbackActionCodeEnum: {
+    readonly SellerActionCompleted: "SELLER_ACTION_COMPLETED";
+};
+type RecordActionFeedbackRequestFeedbackActionCodeEnum = typeof RecordActionFeedbackRequestFeedbackActionCodeEnum[keyof typeof RecordActionFeedbackRequestFeedbackActionCodeEnum];
+
+/**
+ * ApplicationIntegrationsApi - axios parameter creator
+ */
+declare const ApplicationIntegrationsApiAxiosParamCreator: (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 &#x60;createNotification&#x60; operation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNotification: (body: CreateNotificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 &#x60;deleteNotifications&#x60; operation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotifications: (body: DeleteNotificationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 &#x60;notificationId&#x60; uniquely identifies a notification.
+     * @param {RecordActionFeedbackRequest} body The request body for the &#x60;recordActionFeedback&#x60; operation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recordActionFeedback: (notificationId: string, body: RecordActionFeedbackRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ApplicationIntegrationsApi - functional programming interface
+ */
+declare const ApplicationIntegrationsApiFp: (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 &#x60;createNotification&#x60; operation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNotification(body: CreateNotificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationResponse>>;
+    /**
+     * 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 &#x60;deleteNotifications&#x60; operation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotifications(body: DeleteNotificationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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 &#x60;notificationId&#x60; uniquely identifies a notification.
+     * @param {RecordActionFeedbackRequest} body The request body for the &#x60;recordActionFeedback&#x60; operation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recordActionFeedback(notificationId: string, body: RecordActionFeedbackRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ApplicationIntegrationsApi - factory interface
+ */
+declare const ApplicationIntegrationsApiFactory: (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 {ApplicationIntegrationsApiCreateNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNotification(requestParameters: ApplicationIntegrationsApiCreateNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateNotificationResponse>;
+    /**
+     * 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 {ApplicationIntegrationsApiDeleteNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotifications(requestParameters: ApplicationIntegrationsApiDeleteNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * 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 {ApplicationIntegrationsApiRecordActionFeedbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recordActionFeedback(requestParameters: ApplicationIntegrationsApiRecordActionFeedbackRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for createNotification operation in ApplicationIntegrationsApi.
+ */
+interface ApplicationIntegrationsApiCreateNotificationRequest {
+    /**
+     * The request body for the &#x60;createNotification&#x60; operation.
+     */
+    readonly body: CreateNotificationRequest;
+}
+/**
+ * Request parameters for deleteNotifications operation in ApplicationIntegrationsApi.
+ */
+interface ApplicationIntegrationsApiDeleteNotificationsRequest {
+    /**
+     * The request body for the &#x60;deleteNotifications&#x60; operation.
+     */
+    readonly body: DeleteNotificationsRequest;
+}
+/**
+ * Request parameters for recordActionFeedback operation in ApplicationIntegrationsApi.
+ */
+interface ApplicationIntegrationsApiRecordActionFeedbackRequest {
+    /**
+     * A &#x60;notificationId&#x60; uniquely identifies a notification.
+     */
+    readonly notificationId: string;
+    /**
+     * The request body for the &#x60;recordActionFeedback&#x60; operation.
+     */
+    readonly body: RecordActionFeedbackRequest;
+}
+/**
+ * ApplicationIntegrationsApi - object-oriented interface
+ */
+declare class ApplicationIntegrationsApi 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 {ApplicationIntegrationsApiCreateNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNotification(requestParameters: ApplicationIntegrationsApiCreateNotificationRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateNotificationResponse, any, {}>>;
+    /**
+     * 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 {ApplicationIntegrationsApiDeleteNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotifications(requestParameters: ApplicationIntegrationsApiDeleteNotificationsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
+    /**
+     * 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 {ApplicationIntegrationsApiRecordActionFeedbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recordActionFeedback(requestParameters: ApplicationIntegrationsApiRecordActionFeedbackRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
+}
+
+declare const clientRateLimits: RateLimit[];
+declare class ApplicationIntegrationsApiClient extends ApplicationIntegrationsApi {
+    constructor(configuration: ClientConfiguration);
+}
+
+export { ApplicationIntegrationsApi, ApplicationIntegrationsApiAxiosParamCreator, ApplicationIntegrationsApiClient, type ApplicationIntegrationsApiCreateNotificationRequest, type ApplicationIntegrationsApiDeleteNotificationsRequest, ApplicationIntegrationsApiFactory, ApplicationIntegrationsApiFp, type ApplicationIntegrationsApiRecordActionFeedbackRequest, type CreateNotificationRequest, type CreateNotificationResponse, type DeleteNotificationsRequest, DeleteNotificationsRequestDeletionReasonEnum, type ErrorList, type ModelError, type RecordActionFeedbackRequest, RecordActionFeedbackRequestFeedbackActionCodeEnum, clientRateLimits };