@sp-api-sdk/application-integrations-api-2024-04-01 1.1.0

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

@@ -0,0 +1,65 @@
+/**
+ * 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 type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

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

@@ -0,0 +1,91 @@
+/**
+ * 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.
+ */
+export 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>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    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;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/types/src/api-model/models/create-notification-request.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ * @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;
+}

package/dist/types/src/api-model/models/create-notification-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ * @export
+ * @interface CreateNotificationResponse
+ */
+export interface CreateNotificationResponse {
+    /**
+     * The unique identifier assigned to each notification.
+     * @type {string}
+     * @memberof CreateNotificationResponse
+     */
+    'notificationId'?: string;
+}

package/dist/types/src/api-model/models/delete-notifications-request.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ * @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;
+}
+export declare const DeleteNotificationsRequestDeletionReasonEnum: {
+    readonly Content: "INCORRECT_CONTENT";
+    readonly Recipient: "INCORRECT_RECIPIENT";
+};
+export type DeleteNotificationsRequestDeletionReasonEnum = typeof DeleteNotificationsRequestDeletionReasonEnum[keyof typeof DeleteNotificationsRequestDeletionReasonEnum];

package/dist/types/src/api-model/models/error-list.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ * @export
+ * @interface ErrorList
+ */
+export interface ErrorList {
+    /**
+     * Error response returned when the request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof ErrorList
+     */
+    'errors': Array<Error>;
+}

package/dist/types/src/api-model/models/index.d.ts

@@ -0,0 +1,6 @@
+export * from './create-notification-request';
+export * from './create-notification-response';
+export * from './delete-notifications-request';
+export * from './error-list';
+export * from './model-error';
+export * from './record-action-feedback-request';

package/dist/types/src/api-model/models/model-error.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ * @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;
+}

package/dist/types/src/api-model/models/record-action-feedback-request.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ * @export
+ * @interface RecordActionFeedbackRequest
+ */
+export interface RecordActionFeedbackRequest {
+    /**
+     * The unique identifier for each notification status.
+     * @type {string}
+     * @memberof RecordActionFeedbackRequest
+     */
+    'feedbackActionCode': RecordActionFeedbackRequestFeedbackActionCodeEnum;
+}
+export declare const RecordActionFeedbackRequestFeedbackActionCodeEnum: {
+    readonly SellerActionCompleted: "SELLER_ACTION_COMPLETED";
+};
+export type RecordActionFeedbackRequestFeedbackActionCodeEnum = typeof RecordActionFeedbackRequestFeedbackActionCodeEnum[keyof typeof RecordActionFeedbackRequestFeedbackActionCodeEnum];

package/dist/types/src/client.d.ts

@@ -0,0 +1,6 @@
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
+import { AppIntegrationsApi } from './api-model';
+export declare const clientRateLimits: RateLimit[];
+export declare class ApplicationIntegrationsApiClient extends AppIntegrationsApi {
+    constructor(configuration: ClientConfiguration);
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@sp-api-sdk/application-integrations-api-2024-04-01",
+  "author": "Bertrand Marron <bertrand@bizon.solutions>",
+  "description": "With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.",
+  "version": "1.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "dependencies": {
+    "@sp-api-sdk/common": "2.0.14",
+    "axios": "^1.7.7"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bizon/selling-partner-api-sdk.git",
+    "directory": "clients/application-integrations-api-2024-04-01"
+  },
+  "bugs": {
+    "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
+  },
+  "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/application-integrations-api-2024-04-01",
+  "keywords": [
+    "amazon",
+    "bizon",
+    "marketplace web services",
+    "mws",
+    "selling partner api",
+    "sp api",
+    "sp sdk",
+    "application integrations api"
+  ],
+  "gitHead": "bb6066a8853a3548e6de770dacf3259fc1314345"
+}