@whitebox-co/walmart-marketplace-api/lib/src/apis/notifications.d.ts

A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API

/**
 * Notifications Management
 * Notifications Management API
 *
 * The version of the OpenAPI document: 1.0.0
 *
 *
 * 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';
/**
 * Authentication details for accessing the destination URL, if URL is protected
 * @export
 * @interface AuthDetails
 */
export interface AuthDetails {
    /**
     * enumeration: BASIC_AUTH,OAUTH,HMAC
     * @type {string}
     * @memberof AuthDetails
     */
    authMethod?: string;
    /**
     * UserName to access destination URL
     * @type {string}
     * @memberof AuthDetails
     */
    userName?: string;
    /**
     * Password to access destination URL
     * @type {string}
     * @memberof AuthDetails
     */
    password?: string;
    /**
     * authHeaderName , using which authorization header will be passed
     * @type {string}
     * @memberof AuthDetails
     */
    authHeaderName?: string;
    /**
     * OAUTH URL
     * @type {string}
     * @memberof AuthDetails
     */
    authUrl?: string;
    /**
     * Client Secret for OAUTH URL / HMAC
     * @type {string}
     * @memberof AuthDetails
     */
    clientSecret?: string;
    /**
     * ClientId for OAUTH URL
     * @type {string}
     * @memberof AuthDetails
     */
    clientId?: string;
}
/**
 *
 * @export
 * @interface CreateSubscriptionRequest
 */
export interface CreateSubscriptionRequest {
    /**
     *
     * @type {Array<V3WebhooksSubscriptionsEvents>}
     * @memberof CreateSubscriptionRequest
     */
    events?: Array<V3WebhooksSubscriptionsEvents>;
}
/**
 *
 * @export
 * @interface CreateSubscriptionRequestRecord
 */
export interface CreateSubscriptionRequestRecord {
    /**
     * Event that you want to subscribe to. For all allowed eventType(s) see Event Payload section or use GET Event Types API
     * @type {string}
     * @memberof CreateSubscriptionRequestRecord
     */
    eventType: string;
    /**
     * Version of the specific event type. For all eventVersion(s) for each eventType, see Event Payload section or use GET Event Types API
     * @type {string}
     * @memberof CreateSubscriptionRequestRecord
     */
    eventVersion: string;
    /**
     * Delegated access scope that event type is mapped to. For all allowed resourceName(s) for each eventType, see Event Payload section or use GET Event Types API
     * @type {string}
     * @memberof CreateSubscriptionRequestRecord
     */
    resourceName: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof CreateSubscriptionRequestRecord
     */
    eventUrl: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof CreateSubscriptionRequestRecord
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof CreateSubscriptionRequestRecord
     */
    headers?: V3WebhooksTestHeaders;
    /**
     * Status of the subscription. Allowed values are ACTIVE or INACTIVE. To create subscription, use status = ACTIVE. Notification will be triggered only if subscription is in ACTIVE status
     * @type {string}
     * @memberof CreateSubscriptionRequestRecord
     */
    status: string;
}
/**
 * List of event types
 * @export
 * @interface EventType
 */
export interface EventType {
    /**
     * Delegated access scope that event type is mapped to.
     * @type {string}
     * @memberof EventType
     */
    resourceName?: string;
    /**
     * Event that you want to subscribe to.
     * @type {string}
     * @memberof EventType
     */
    eventType?: string;
    /**
     * Version of the specific event type
     * @type {string}
     * @memberof EventType
     */
    eventVersion?: string;
    /**
     * Description of the specific event type
     * @type {string}
     * @memberof EventType
     */
    description?: string;
}
/**
 *
 * @export
 * @interface EventTypes
 */
export interface EventTypes {
    /**
     * List of event types
     * @type {Array<InlineResponse2003EventTypes>}
     * @memberof EventTypes
     */
    eventTypes?: Array<InlineResponse2003EventTypes>;
}
/**
 *
 * @export
 * @interface Events
 */
export interface Events {
    /**
     * List of events
     * @type {Array<InlineResponse2001Events>}
     * @memberof Events
     */
    events?: Array<InlineResponse2001Events>;
}
/**
 * Headers required for accessing the destination URL
 * @export
 * @interface Headers
 */
export interface Headers {
    /**
     *
     * @type {string}
     * @memberof Headers
     */
    content_type?: string;
}
/**
 *
 * @export
 * @interface InlineObject
 */
export interface InlineObject {
    /**
     * Event that you want to subscribe to
     * @type {string}
     * @memberof InlineObject
     */
    eventType: string;
    /**
     * Version of the specific event type
     * @type {string}
     * @memberof InlineObject
     */
    eventVersion: string;
    /**
     * Functional category that event type is mapped to.
     * @type {string}
     * @memberof InlineObject
     */
    resourceName: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof InlineObject
     */
    eventUrl: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof InlineObject
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof InlineObject
     */
    headers?: V3WebhooksTestHeaders;
}
/**
 *
 * @export
 * @interface InlineObject1
 */
export interface InlineObject1 {
    /**
     *
     * @type {Array<V3WebhooksSubscriptionsEvents>}
     * @memberof InlineObject1
     */
    events?: Array<V3WebhooksSubscriptionsEvents>;
}
/**
 *
 * @export
 * @interface InlineObject2
 */
export interface InlineObject2 {
    /**
     * Event that is subscribed for notifications.
     * @type {string}
     * @memberof InlineObject2
     */
    eventType?: string;
    /**
     * Version of the specific event type
     * @type {string}
     * @memberof InlineObject2
     */
    eventVersion?: string;
    /**
     * Delegated access scope that event type is mapped to.
     * @type {string}
     * @memberof InlineObject2
     */
    resourceName?: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof InlineObject2
     */
    eventUrl?: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof InlineObject2
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof InlineObject2
     */
    headers?: V3WebhooksTestHeaders;
    /**
     * Status of the subscription. Allowed values are ACTIVE or INACTIVE
     * @type {string}
     * @memberof InlineObject2
     */
    status?: string;
}
/**
 *
 * @export
 * @interface InlineResponse200
 */
export interface InlineResponse200 {
    /**
     * Message confirming that the eventURL is validated
     * @type {string}
     * @memberof InlineResponse200
     */
    message?: string;
}
/**
 *
 * @export
 * @interface InlineResponse2001
 */
export interface InlineResponse2001 {
    /**
     * List of events
     * @type {Array<InlineResponse2001Events>}
     * @memberof InlineResponse2001
     */
    events?: Array<InlineResponse2001Events>;
}
/**
 *
 * @export
 * @interface InlineResponse2001Event
 */
export interface InlineResponse2001Event {
    /**
     * Event for which the subscription is created
     * @type {string}
     * @memberof InlineResponse2001Event
     */
    eventType?: string;
    /**
     * Unique ID for the subscription that can be used for fetching details, editing or deleting the subscription
     * @type {string}
     * @memberof InlineResponse2001Event
     */
    subscriptionId?: string;
    /**
     * Partner ID of the seller who created the subscription
     * @type {string}
     * @memberof InlineResponse2001Event
     */
    partnerId?: string;
    /**
     * Version of the event type for which the subscription is created
     * @type {string}
     * @memberof InlineResponse2001Event
     */
    eventVersion?: string;
    /**
     * Delegated access scope that event type is mapped to.
     * @type {string}
     * @memberof InlineResponse2001Event
     */
    resourceName?: string;
    /**
     * ACTIVE or INACTIVE status of the subscription
     * @type {string}
     * @memberof InlineResponse2001Event
     */
    status?: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof InlineResponse2001Event
     */
    eventUrl?: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof InlineResponse2001Event
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof InlineResponse2001Event
     */
    headers?: V3WebhooksTestHeaders;
}
/**
 * List of events
 * @export
 * @interface InlineResponse2001Events
 */
export interface InlineResponse2001Events {
    /**
     *
     * @type {Array<InlineResponse2001Event>}
     * @memberof InlineResponse2001Events
     */
    event?: Array<InlineResponse2001Event>;
}
/**
 *
 * @export
 * @interface InlineResponse2002
 */
export interface InlineResponse2002 {
    /**
     * Subscription Id of the subscription that is deleted
     * @type {string}
     * @memberof InlineResponse2002
     */
    subscriptionId?: string;
    /**
     * Message confirming that the subscription has been deleted
     * @type {string}
     * @memberof InlineResponse2002
     */
    message?: string;
}
/**
 *
 * @export
 * @interface InlineResponse2003
 */
export interface InlineResponse2003 {
    /**
     * List of event types
     * @type {Array<InlineResponse2003EventTypes>}
     * @memberof InlineResponse2003
     */
    eventTypes?: Array<InlineResponse2003EventTypes>;
}
/**
 * List of event types
 * @export
 * @interface InlineResponse2003EventTypes
 */
export interface InlineResponse2003EventTypes {
    /**
     * Delegated access scope that event type is mapped to.
     * @type {string}
     * @memberof InlineResponse2003EventTypes
     */
    resourceName?: string;
    /**
     * Event that you want to subscribe to.
     * @type {string}
     * @memberof InlineResponse2003EventTypes
     */
    eventType?: string;
    /**
     * Version of the specific event type
     * @type {string}
     * @memberof InlineResponse2003EventTypes
     */
    eventVersion?: string;
    /**
     * Description of the specific event type
     * @type {string}
     * @memberof InlineResponse2003EventTypes
     */
    description?: string;
}
/**
 *
 * @export
 * @interface SubscriptionDeleteResponseDTO
 */
export interface SubscriptionDeleteResponseDTO {
    /**
     * Subscription Id of the subscription that is deleted
     * @type {string}
     * @memberof SubscriptionDeleteResponseDTO
     */
    subscriptionId?: string;
    /**
     * Message confirming that the subscription has been deleted
     * @type {string}
     * @memberof SubscriptionDeleteResponseDTO
     */
    message?: string;
}
/**
 * List of events
 * @export
 * @interface SubscriptionResponseDTO
 */
export interface SubscriptionResponseDTO {
    /**
     *
     * @type {Array<InlineResponse2001Event>}
     * @memberof SubscriptionResponseDTO
     */
    event?: Array<InlineResponse2001Event>;
}
/**
 *
 * @export
 * @interface SubscriptionResponseDTORecord
 */
export interface SubscriptionResponseDTORecord {
    /**
     * Event for which the subscription is created
     * @type {string}
     * @memberof SubscriptionResponseDTORecord
     */
    eventType?: string;
    /**
     * Unique ID for the subscription that can be used for fetching details, editing or deleting the subscription
     * @type {string}
     * @memberof SubscriptionResponseDTORecord
     */
    subscriptionId?: string;
    /**
     * Partner ID of the seller who created the subscription
     * @type {string}
     * @memberof SubscriptionResponseDTORecord
     */
    partnerId?: string;
    /**
     * Version of the event type for which the subscription is created
     * @type {string}
     * @memberof SubscriptionResponseDTORecord
     */
    eventVersion?: string;
    /**
     * Delegated access scope that event type is mapped to.
     * @type {string}
     * @memberof SubscriptionResponseDTORecord
     */
    resourceName?: string;
    /**
     * ACTIVE or INACTIVE status of the subscription
     * @type {string}
     * @memberof SubscriptionResponseDTORecord
     */
    status?: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof SubscriptionResponseDTORecord
     */
    eventUrl?: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof SubscriptionResponseDTORecord
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof SubscriptionResponseDTORecord
     */
    headers?: V3WebhooksTestHeaders;
}
/**
 *
 * @export
 * @interface TestNotificationRequest
 */
export interface TestNotificationRequest {
    /**
     * Event that you want to subscribe to
     * @type {string}
     * @memberof TestNotificationRequest
     */
    eventType: string;
    /**
     * Version of the specific event type
     * @type {string}
     * @memberof TestNotificationRequest
     */
    eventVersion: string;
    /**
     * Functional category that event type is mapped to.
     * @type {string}
     * @memberof TestNotificationRequest
     */
    resourceName: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof TestNotificationRequest
     */
    eventUrl: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof TestNotificationRequest
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof TestNotificationRequest
     */
    headers?: V3WebhooksTestHeaders;
}
/**
 *
 * @export
 * @interface TestNotificationResponseDTO
 */
export interface TestNotificationResponseDTO {
    /**
     * Message confirming that the eventURL is validated
     * @type {string}
     * @memberof TestNotificationResponseDTO
     */
    message?: string;
}
/**
 *
 * @export
 * @interface UpdateSubscriptionRequest
 */
export interface UpdateSubscriptionRequest {
    /**
     * Event that is subscribed for notifications.
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    eventType?: string;
    /**
     * Version of the specific event type
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    eventVersion?: string;
    /**
     * Delegated access scope that event type is mapped to.
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    resourceName?: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    eventUrl?: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof UpdateSubscriptionRequest
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof UpdateSubscriptionRequest
     */
    headers?: V3WebhooksTestHeaders;
    /**
     * Status of the subscription. Allowed values are ACTIVE or INACTIVE
     * @type {string}
     * @memberof UpdateSubscriptionRequest
     */
    status?: string;
}
/**
 *
 * @export
 * @interface V3WebhooksSubscriptionsEvents
 */
export interface V3WebhooksSubscriptionsEvents {
    /**
     * Event that you want to subscribe to. For all allowed eventType(s) see Event Payload section or use GET Event Types API
     * @type {string}
     * @memberof V3WebhooksSubscriptionsEvents
     */
    eventType: string;
    /**
     * Version of the specific event type. For all eventVersion(s) for each eventType, see Event Payload section or use GET Event Types API
     * @type {string}
     * @memberof V3WebhooksSubscriptionsEvents
     */
    eventVersion: string;
    /**
     * Delegated access scope that event type is mapped to. For all allowed resourceName(s) for each eventType, see Event Payload section or use GET Event Types API
     * @type {string}
     * @memberof V3WebhooksSubscriptionsEvents
     */
    resourceName: string;
    /**
     * Destination URL where notification will be received by seller
     * @type {string}
     * @memberof V3WebhooksSubscriptionsEvents
     */
    eventUrl: string;
    /**
     *
     * @type {V3WebhooksTestAuthDetails}
     * @memberof V3WebhooksSubscriptionsEvents
     */
    authDetails?: V3WebhooksTestAuthDetails;
    /**
     *
     * @type {V3WebhooksTestHeaders}
     * @memberof V3WebhooksSubscriptionsEvents
     */
    headers?: V3WebhooksTestHeaders;
    /**
     * Status of the subscription. Allowed values are ACTIVE or INACTIVE. To create subscription, use status = ACTIVE. Notification will be triggered only if subscription is in ACTIVE status
     * @type {string}
     * @memberof V3WebhooksSubscriptionsEvents
     */
    status: string;
}
/**
 * Authentication details for accessing the destination URL, if URL is protected
 * @export
 * @interface V3WebhooksTestAuthDetails
 */
export interface V3WebhooksTestAuthDetails {
    /**
     * enumeration: BASIC_AUTH,OAUTH,HMAC
     * @type {string}
     * @memberof V3WebhooksTestAuthDetails
     */
    authMethod?: string;
    /**
     * UserName to access destination URL
     * @type {string}
     * @memberof V3WebhooksTestAuthDetails
     */
    userName?: string;
    /**
     * Password to access destination URL
     * @type {string}
     * @memberof V3WebhooksTestAuthDetails
     */
    password?: string;
    /**
     * authHeaderName , using which authorization header will be passed
     * @type {string}
     * @memberof V3WebhooksTestAuthDetails
     */
    authHeaderName?: string;
    /**
     * OAUTH URL
     * @type {string}
     * @memberof V3WebhooksTestAuthDetails
     */
    authUrl?: string;
    /**
     * Client Secret for OAUTH URL / HMAC
     * @type {string}
     * @memberof V3WebhooksTestAuthDetails
     */
    clientSecret?: string;
    /**
     * ClientId for OAUTH URL
     * @type {string}
     * @memberof V3WebhooksTestAuthDetails
     */
    clientId?: string;
}
/**
 * Headers required for accessing the destination URL
 * @export
 * @interface V3WebhooksTestHeaders
 */
export interface V3WebhooksTestHeaders {
    /**
     *
     * @type {string}
     * @memberof V3WebhooksTestHeaders
     */
    content_type?: string;
}
/**
 * NotificationsApi - axios parameter creator
 * @export
 */
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * This API is used to create subscription for notification of an event by selecting an event type, event version, resource name, and providing event URL. One or more than one events can be subscribed for notifications in one subscription request.  Use Get Event Types API to get the list of event type, event version and resource name available for subscribing.  Configure an event URL to receive the notifications.  URL Authentication Options If authMethod is BASIC_AUTH, while making notification request to endpointUrl, Walmart system will pass authentication header with key as authHeaderName and value as BASE64 encoding of userName and password. If authMethod is HMAC, while making notification request to endpointUrl, Walmart system will pass authentication header with key as authHeaderName and value as HMACSHA256 of complete response, using clientSecret as key. If authMethod is OAUTH, Walmart system will make POST call to authUrl to generate token with request body as \"grant_type=client_credentials\" and headers as : Authorization header with key as authHeaderName and value as BASE64 encoding of clientId and clientSecret \"Accept\" :\"application/json; charset=UTF-8\" \"Content-type\":\"application/x-www-form-urlencoded; charset=ISO-8859-1\" Custom headers provided in headers field , if provided authURL should return HTTPS status 200 and response should have access_token and expires_in field. While making notification request to endpointUrl, Walmart system will pass access_token in headers with authHeaderName as key and value as Bearer <access_token> along with any other custom headers provided in headers field.
     * @summary Create subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject1} inlineObject1
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSubscription: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject1: InlineObject1, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
    /**
     * This API is used to delete the subscription. Once deleted, the subscription cannot be retrieved.
     * @summary Delete Subscription
     * @param {string} subscriptionId Unique ID for the subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSubscription: (subscriptionId: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
    /**
     * This API is used to retrieve the details of all subscriptions created using \"create subscription\" API.
     * @summary All subscriptions
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [subscriptionId] Use this to get details of a specific subscription
     * @param {string} [eventType] Use this to get list of all subscriptions for a specific event type. Refer to Events section for list of available eventType.
     * @param {string} [resourceName] Use this to get list of all subscriptions for a specific resource. Refer to Events section for list of available resourceName.
     * @param {string} [status] Use this to get list of all subscriptions in ACTIVE or INACTIVE status
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAllSubscriptions: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, subscriptionId?: string, eventType?: string, resourceName?: string, status?: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
    /**
     * This API provides the list of event types and resource names that you can subscribe to. Notifications will be triggered only for the event types that you subscribe to using Create Subscription API .  Event Types are workflow events that are triggered when status or conditions change. Some examples are an offer moving from published to unpublished status, an order getting auto-cancelled by Walmart, a buy box price/winner change, etc.  Resource Names are functional API categories that group similar event types. Resource Names can be Item, Price, Orders, Inventory, etc. The permissions to subscribe to an Event Type is defined by Resource Name which is mapped to permissions in Delegated Access.
     * @summary Event Types
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEventTypes: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
    /**
     * This API can be used to send a test notification to the destination URL with the sample payload.
     * @summary Test Notification
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject} inlineObject
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testNotification: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject: InlineObject, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
    /**
     * This API is used to update the details of subscriptions. You can update event version, event URL, headers, authentication details of a subscription using this API. You can also disable/enable the subscription by changing the status from ACTIVE to INACTIVE or vice versa .
     * @summary Update Subscription
     * @param {string} subscriptionId Unique ID for the subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject2} inlineObject2
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSubscription: (subscriptionId: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject2: InlineObject2, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
};
/**
 * NotificationsApi - functional programming interface
 * @export
 */
export declare const NotificationsApiFp: (configuration?: Configuration) => {
    /**
     * This API is used to create subscription for notification of an event by selecting an event type, event version, resource name, and providing event URL. One or more than one events can be subscribed for notifications in one subscription request.  Use Get Event Types API to get the list of event type, event version and resource name available for subscribing.  Configure an event URL to receive the notifications.  URL Authentication Options If authMethod is BASIC_AUTH, while making notification request to endpointUrl, Walmart system will pass authentication header with key as authHeaderName and value as BASE64 encoding of userName and password. If authMethod is HMAC, while making notification request to endpointUrl, Walmart system will pass authentication header with key as authHeaderName and value as HMACSHA256 of complete response, using clientSecret as key. If authMethod is OAUTH, Walmart system will make POST call to authUrl to generate token with request body as \"grant_type=client_credentials\" and headers as : Authorization header with key as authHeaderName and value as BASE64 encoding of clientId and clientSecret \"Accept\" :\"application/json; charset=UTF-8\" \"Content-type\":\"application/x-www-form-urlencoded; charset=ISO-8859-1\" Custom headers provided in headers field , if provided authURL should return HTTPS status 200 and response should have access_token and expires_in field. While making notification request to endpointUrl, Walmart system will pass access_token in headers with authHeaderName as key and value as Bearer <access_token> along with any other custom headers provided in headers field.
     * @summary Create subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject1} inlineObject1
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSubscription(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject1: InlineObject1, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001Events>>;
    /**
     * This API is used to delete the subscription. Once deleted, the subscription cannot be retrieved.
     * @summary Delete Subscription
     * @param {string} subscriptionId Unique ID for the subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSubscription(subscriptionId: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>;
    /**
     * This API is used to retrieve the details of all subscriptions created using \"create subscription\" API.
     * @summary All subscriptions
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [subscriptionId] Use this to get details of a specific subscription
     * @param {string} [eventType] Use this to get list of all subscriptions for a specific event type. Refer to Events section for list of available eventType.
     * @param {string} [resourceName] Use this to get list of all subscriptions for a specific resource. Refer to Events section for list of available resourceName.
     * @param {string} [status] Use this to get list of all subscriptions in ACTIVE or INACTIVE status
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAllSubscriptions(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, subscriptionId?: string, eventType?: string, resourceName?: string, status?: string, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>;
    /**
     * This API provides the list of event types and resource names that you can subscribe to. Notifications will be triggered only for the event types that you subscribe to using Create Subscription API .  Event Types are workflow events that are triggered when status or conditions change. Some examples are an offer moving from published to unpublished status, an order getting auto-cancelled by Walmart, a buy box price/winner change, etc.  Resource Names are functional API categories that group similar event types. Resource Names can be Item, Price, Orders, Inventory, etc. The permissions to subscribe to an Event Type is defined by Resource Name which is mapped to permissions in Delegated Access.
     * @summary Event Types
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEventTypes(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
    /**
     * This API can be used to send a test notification to the destination URL with the sample payload.
     * @summary Test Notification
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject} inlineObject
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testNotification(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject: InlineObject, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
    /**
     * This API is used to update the details of subscriptions. You can update event version, event URL, headers, authentication details of a subscription using this API. You can also disable/enable the subscription by changing the status from ACTIVE to INACTIVE or vice versa .
     * @summary Update Subscription
     * @param {string} subscriptionId Unique ID for the subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject2} inlineObject2
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSubscription(subscriptionId: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject2: InlineObject2, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001Events>>;
};
/**
 * NotificationsApi - factory interface
 * @export
 */
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * This API is used to create subscription for notification of an event by selecting an event type, event version, resource name, and providing event URL. One or more than one events can be subscribed for notifications in one subscription request.  Use Get Event Types API to get the list of event type, event version and resource name available for subscribing.  Configure an event URL to receive the notifications.  URL Authentication Options If authMethod is BASIC_AUTH, while making notification request to endpointUrl, Walmart system will pass authentication header with key as authHeaderName and value as BASE64 encoding of userName and password. If authMethod is HMAC, while making notification request to endpointUrl, Walmart system will pass authentication header with key as authHeaderName and value as HMACSHA256 of complete response, using clientSecret as key. If authMethod is OAUTH, Walmart system will make POST call to authUrl to generate token with request body as \"grant_type=client_credentials\" and headers as : Authorization header with key as authHeaderName and value as BASE64 encoding of clientId and clientSecret \"Accept\" :\"application/json; charset=UTF-8\" \"Content-type\":\"application/x-www-form-urlencoded; charset=ISO-8859-1\" Custom headers provided in headers field , if provided authURL should return HTTPS status 200 and response should have access_token and expires_in field. While making notification request to endpointUrl, Walmart system will pass access_token in headers with authHeaderName as key and value as Bearer <access_token> along with any other custom headers provided in headers field.
     * @summary Create subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject1} inlineObject1
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSubscription(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject1: InlineObject1, wMCONSUMERCHANNELTYPE?: string, options?: any): AxiosPromise<InlineResponse2001Events>;
    /**
     * This API is used to delete the subscription. Once deleted, the subscription cannot be retrieved.
     * @summary Delete Subscription
     * @param {string} subscriptionId Unique ID for the subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSubscription(subscriptionId: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any): AxiosPromise<InlineResponse2002>;
    /**
     * This API is used to retrieve the details of all subscriptions created using \"create subscription\" API.
     * @summary All subscriptions
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [subscriptionId] Use this to get details of a specific subscription
     * @param {string} [eventType] Use this to get list of all subscriptions for a specific event type. Refer to Events section for list of available eventType.
     * @param {string} [resourceName] Use this to get list of all subscriptions for a specific resource. Refer to Events section for list of available resourceName.
     * @param {string} [status] Use this to get list of all subscriptions in ACTIVE or INACTIVE status
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAllSubscriptions(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, subscriptionId?: string, eventType?: string, resourceName?: string, status?: string, wMCONSUMERCHANNELTYPE?: string, options?: any): AxiosPromise<InlineResponse2001>;
    /**
     * This API provides the list of event types and resource names that you can subscribe to. Notifications will be triggered only for the event types that you subscribe to using Create Subscription API .  Event Types are workflow events that are triggered when status or conditions change. Some examples are an offer moving from published to unpublished status, an order getting auto-cancelled by Walmart, a buy box price/winner change, etc.  Resource Names are functional API categories that group similar event types. Resource Names can be Item, Price, Orders, Inventory, etc. The permissions to subscribe to an Event Type is defined by Resource Name which is mapped to permissions in Delegated Access.
     * @summary Event Types
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEventTypes(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any): AxiosPromise<InlineResponse2003>;
    /**
     * This API can be used to send a test notification to the destination URL with the sample payload.
     * @summary Test Notification
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject} inlineObject
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testNotification(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject: InlineObject, wMCONSUMERCHANNELTYPE?: string, options?: any): AxiosPromise<InlineResponse200>;
    /**
     * This API is used to update the details of subscriptions. You can update event version, event URL, headers, authentication details of a subscription using this API. You can also disable/enable the subscription by changing the status from ACTIVE to INACTIVE or vice versa .
     * @summary Update Subscription
     * @param {string} subscriptionId Unique ID for the subscription
     * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
     * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @param {string} wMSVCNAME Walmart Service Name
     * @param {InlineObject2} inlineObject2
     * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSubscription(subscriptionId: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject2: InlineObject2, wMCONSUMERCHANNELTYPE?: string, options?: any): AxiosPromise<InlineResponse2001Events>;
};
/**
 * Request parameters for createSubscription operation in NotificationsApi.
 * @export
 * @interface NotificationsApiCreateSubscriptionRequest
 */
export interface NotificationsApiCreateSubscriptionRequest {
    /**
     * Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
     * @type {string}
     * @memberof NotificationsApiCreateSubscription
     */
    readonly authorization: string;
    /**
     * The access token retrieved in the Token API call
     * @type {string}
     * @memberof NotificationsApiCreateSubscription
     */
    readonly wMSECACCESSTOKEN: string;
    /**
     * A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
     * @type {string}
     * @memberof NotificationsApiCreateSubscription
     */
    readonly wMQOSCORRELATIONID: string;
    /**
     * Walmart Service Name
     * @type {string}
     * @memberof NotificationsAp