/** * Selling Partner API for Messaging * With the Messaging API you can build applications that send messages to buyers. You can get a list of message types that are available for an order that you specify, then call an operation that sends a message to the buyer for that order. The Messaging API returns responses that are formed according to the JSON Hypertext Application Language (HAL) standard. * * The version of the OpenAPI document: v1 * * * 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'; /** * Represents a file that was uploaded to a destination that was created by the Uploads API [`createUploadDestinationForResource`](https://developer-docs.amazon.com/sp-api/docs/uploads-api-reference#post-uploads2020-11-01uploaddestinationsresource) operation. * @export * @interface Attachment */ export interface Attachment { /** * The identifier for the upload destination. To retrieve this value, call the Uploads API [`createUploadDestinationForResource`](https://developer-docs.amazon.com/sp-api/docs/uploads-api-reference#post-uploads2020-11-01uploaddestinationsresource) operation. * @type {string} * @memberof Attachment */ uploadDestinationId: string; /** * The name of the file, including the extension. This is the file name that will appear in the message. This does not need to match the file name of the file that you uploaded. * @type {string} * @memberof Attachment */ fileName: string; } /** * The request schema for the createAmazonMotors operation. * @export * @interface CreateAmazonMotorsRequest */ export interface CreateAmazonMotorsRequest { /** * Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {Array} * @memberof CreateAmazonMotorsRequest */ attachments?: Array; } /** * The response schema for the createAmazonMotors operation. * @export * @interface CreateAmazonMotorsResponse */ export interface CreateAmazonMotorsResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateAmazonMotorsResponse */ errors?: Array; } /** * The request schema for the confirmCustomizationDetails operation. * @export * @interface CreateConfirmCustomizationDetailsRequest */ export interface CreateConfirmCustomizationDetailsRequest { /** * The text to be sent to the buyer. Only links related to customization details are allowed. Do not include HTML or email addresses. The text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {string} * @memberof CreateConfirmCustomizationDetailsRequest */ text?: string; /** * Attachments to include in the message to the buyer. * @type {Array} * @memberof CreateConfirmCustomizationDetailsRequest */ attachments?: Array; } /** * The response schema for the confirmCustomizationDetails operation. * @export * @interface CreateConfirmCustomizationDetailsResponse */ export interface CreateConfirmCustomizationDetailsResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateConfirmCustomizationDetailsResponse */ errors?: Array; } /** * The request schema for the createConfirmDeliveryDetails operation. * @export * @interface CreateConfirmDeliveryDetailsRequest */ export interface CreateConfirmDeliveryDetailsRequest { /** * The text to be sent to the buyer. Only links related to order delivery are allowed. Do not include HTML or email addresses. The text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {string} * @memberof CreateConfirmDeliveryDetailsRequest */ text?: string; } /** * The response schema for the createConfirmDeliveryDetails operation. * @export * @interface CreateConfirmDeliveryDetailsResponse */ export interface CreateConfirmDeliveryDetailsResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateConfirmDeliveryDetailsResponse */ errors?: Array; } /** * The request schema for the createConfirmOrderDetails operation. * @export * @interface CreateConfirmOrderDetailsRequest */ export interface CreateConfirmOrderDetailsRequest { /** * The text to be sent to the buyer. Only links related to order completion are allowed. Do not include HTML or email addresses. The text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {string} * @memberof CreateConfirmOrderDetailsRequest */ text?: string; } /** * The response schema for the createConfirmOrderDetails operation. * @export * @interface CreateConfirmOrderDetailsResponse */ export interface CreateConfirmOrderDetailsResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateConfirmOrderDetailsResponse */ errors?: Array; } /** * The request schema for the createConfirmServiceDetails operation. * @export * @interface CreateConfirmServiceDetailsRequest */ export interface CreateConfirmServiceDetailsRequest { /** * The text to be sent to the buyer. Only links related to Home Service calls are allowed. Do not include HTML or email addresses. The text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {string} * @memberof CreateConfirmServiceDetailsRequest */ text?: string; } /** * The response schema for the createConfirmServiceDetails operation. * @export * @interface CreateConfirmServiceDetailsResponse */ export interface CreateConfirmServiceDetailsResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateConfirmServiceDetailsResponse */ errors?: Array; } /** * The request schema for the `createDigitalAccessKey` operation. * @export * @interface CreateDigitalAccessKeyRequest */ export interface CreateDigitalAccessKeyRequest { /** * The text that is sent to the buyer. Only links that are related to the digital access key are allowed. Do not include HTML or email addresses. The text must be written in the buyer\'s preferred language, which you can retrieve from the `GetAttributes` operation. * @type {string} * @memberof CreateDigitalAccessKeyRequest */ text?: string; /** * Attachments that you want to include in the message to the buyer. * @type {Array} * @memberof CreateDigitalAccessKeyRequest */ attachments?: Array; } /** * The response schema for the `createDigitalAccessKey` operation. * @export * @interface CreateDigitalAccessKeyResponse */ export interface CreateDigitalAccessKeyResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateDigitalAccessKeyResponse */ errors?: Array; } /** * The request schema for the createLegalDisclosure operation. * @export * @interface CreateLegalDisclosureRequest */ export interface CreateLegalDisclosureRequest { /** * Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {Array} * @memberof CreateLegalDisclosureRequest */ attachments?: Array; } /** * The response schema for the createLegalDisclosure operation. * @export * @interface CreateLegalDisclosureResponse */ export interface CreateLegalDisclosureResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateLegalDisclosureResponse */ errors?: Array; } /** * The response schema for the createNegativeFeedbackRemoval operation. * @export * @interface CreateNegativeFeedbackRemovalResponse */ export interface CreateNegativeFeedbackRemovalResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateNegativeFeedbackRemovalResponse */ errors?: Array; } /** * The request schema for the createUnexpectedProblem operation. * @export * @interface CreateUnexpectedProblemRequest */ export interface CreateUnexpectedProblemRequest { /** * The text to be sent to the buyer. Only links related to unexpected problem calls are allowed. Do not include HTML or email addresses. The text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {string} * @memberof CreateUnexpectedProblemRequest */ text?: string; } /** * The response schema for the createUnexpectedProblem operation. * @export * @interface CreateUnexpectedProblemResponse */ export interface CreateUnexpectedProblemResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateUnexpectedProblemResponse */ errors?: Array; } /** * The request schema for the createWarranty operation. * @export * @interface CreateWarrantyRequest */ export interface CreateWarrantyRequest { /** * Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer\'s language of preference, which can be retrieved from the GetAttributes operation. * @type {Array} * @memberof CreateWarrantyRequest */ attachments?: Array; /** * The start date of the warranty coverage to include in the message to the buyer. * @type {string} * @memberof CreateWarrantyRequest */ coverageStartDate?: string; /** * The end date of the warranty coverage to include in the message to the buyer. * @type {string} * @memberof CreateWarrantyRequest */ coverageEndDate?: string; } /** * The response schema for the createWarranty operation. * @export * @interface CreateWarrantyResponse */ export interface CreateWarrantyResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateWarrantyResponse */ errors?: Array; } /** * The response schema for the GetAttributes operation. * @export * @interface GetAttributesResponse */ export interface GetAttributesResponse { /** * * @type {GetAttributesResponseBuyer} * @memberof GetAttributesResponse */ buyer?: GetAttributesResponseBuyer; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetAttributesResponse */ errors?: Array; } /** * The list of attributes related to the buyer. * @export * @interface GetAttributesResponseBuyer */ export interface GetAttributesResponseBuyer { /** * The buyer\'s language of preference, indicated with a locale-specific language tag. Examples: \"en-US\", \"zh-CN\", and \"en-GB\". * @type {string} * @memberof GetAttributesResponseBuyer */ locale?: string; } /** * Describes a messaging action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input. * @export * @interface GetMessagingActionResponse */ export interface GetMessagingActionResponse { /** * * @type {GetMessagingActionResponseLinks} * @memberof GetMessagingActionResponse */ _links?: GetMessagingActionResponseLinks; /** * * @type {GetMessagingActionResponseEmbedded} * @memberof GetMessagingActionResponse */ _embedded?: GetMessagingActionResponseEmbedded; /** * * @type {MessagingAction} * @memberof GetMessagingActionResponse */ payload?: MessagingAction; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetMessagingActionResponse */ errors?: Array; } /** * The embedded response associated with the messaging action. * @export * @interface GetMessagingActionResponseEmbedded */ export interface GetMessagingActionResponseEmbedded { /** * * @type {GetSchemaResponse} * @memberof GetMessagingActionResponseEmbedded */ schema?: GetSchemaResponse; } /** * The links response that is associated with the messaging action. * @export * @interface GetMessagingActionResponseLinks */ export interface GetMessagingActionResponseLinks { /** * * @type {LinkObject} * @memberof GetMessagingActionResponseLinks */ self: LinkObject; /** * * @type {LinkObject} * @memberof GetMessagingActionResponseLinks */ schema: LinkObject; } /** * The response schema for the `getMessagingActionsForOrder` operation. * @export * @interface GetMessagingActionsForOrderResponse */ export interface GetMessagingActionsForOrderResponse { /** * * @type {GetMessagingActionsForOrderResponseLinks} * @memberof GetMessagingActionsForOrderResponse */ _links?: GetMessagingActionsForOrderResponseLinks; /** * * @type {GetMessagingActionsForOrderResponseEmbedded} * @memberof GetMessagingActionsForOrderResponse */ _embedded?: GetMessagingActionsForOrderResponseEmbedded; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetMessagingActionsForOrderResponse */ errors?: Array; } /** * The messaging actions response that is associated with the specified `amazonOrderId`. * @export * @interface GetMessagingActionsForOrderResponseEmbedded */ export interface GetMessagingActionsForOrderResponseEmbedded { /** * * @type {Array} * @memberof GetMessagingActionsForOrderResponseEmbedded */ actions: Array; } /** * The links response that is associated with the specified `amazonOrderId`. * @export * @interface GetMessagingActionsForOrderResponseLinks */ export interface GetMessagingActionsForOrderResponseLinks { /** * * @type {LinkObject} * @memberof GetMessagingActionsForOrderResponseLinks */ self: LinkObject; /** * Eligible actions for the specified amazonOrderId. * @type {Array} * @memberof GetMessagingActionsForOrderResponseLinks */ actions: Array; } /** * The `GET` request schema response. * @export * @interface GetSchemaResponse */ export interface GetSchemaResponse { /** * * @type {GetSchemaResponseLinks} * @memberof GetSchemaResponse */ _links?: GetSchemaResponseLinks; /** * A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema. * @type {{ [key: string]: object; }} * @memberof GetSchemaResponse */ payload?: { [key: string]: object; }; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetSchemaResponse */ errors?: Array; } /** * The links response that is associated with the object. * @export * @interface GetSchemaResponseLinks */ export interface GetSchemaResponseLinks { /** * * @type {LinkObject} * @memberof GetSchemaResponseLinks */ self: LinkObject; } /** * The request schema for the `sendInvoice` operation. * @export * @interface InvoiceRequest */ export interface InvoiceRequest { /** * Attachments to include in the message to the buyer. * @type {Array} * @memberof InvoiceRequest */ attachments?: Array; } /** * The response schema for the sendInvoice operation. * @export * @interface InvoiceResponse */ export interface InvoiceResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof InvoiceResponse */ errors?: Array; } /** * A Link object. * @export * @interface LinkObject */ export interface LinkObject { /** * A URI for this object. * @type {string} * @memberof LinkObject */ href: string; /** * An identifier for this object. * @type {string} * @memberof LinkObject */ name?: string; } /** * A simple object containing the name of the template. * @export * @interface MessagingAction */ export interface MessagingAction { /** * The name of the template. * @type {string} * @memberof MessagingAction */ name: string; } /** * 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; } /** * MessagingApi - axios parameter creator * @export */ export declare const MessagingApiAxiosParamCreator: (configuration?: Configuration) => { /** * Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmCustomizationDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmCustomizationDetails: (amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmCustomizationDetailsRequest, options?: any) => Promise; /** * Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateAmazonMotorsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAmazonMotors: (amazonOrderId: string, marketplaceIds: Array, body: CreateAmazonMotorsRequest, options?: any) => Promise; /** * Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmDeliveryDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmDeliveryDetails: (amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmDeliveryDetailsRequest, options?: any) => Promise; /** * Sends a message to ask a buyer an order-related question prior to shipping their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmOrderDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmOrderDetails: (amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmOrderDetailsRequest, options?: any) => Promise; /** * Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmServiceDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmServiceDetails: (amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmServiceDetailsRequest, options?: any) => Promise; /** * Sends a buyer a message to share a digital access key that is required to utilize digital content in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateDigitalAccessKeyRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDigitalAccessKey: (amazonOrderId: string, marketplaceIds: Array, body: CreateDigitalAccessKeyRequest, options?: any) => Promise; /** * Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateLegalDisclosureRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLegalDisclosure: (amazonOrderId: string, marketplaceIds: Array, body: CreateLegalDisclosureRequest, options?: any) => Promise; /** * Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer\'s problem. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNegativeFeedbackRemoval: (amazonOrderId: string, marketplaceIds: Array, options?: any) => Promise; /** * Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateUnexpectedProblemRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUnexpectedProblem: (amazonOrderId: string, marketplaceIds: Array, body: CreateUnexpectedProblemRequest, options?: any) => Promise; /** * Sends a message to a buyer to provide details about warranty information on a purchase in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateWarrantyRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWarranty: (amazonOrderId: string, marketplaceIds: Array, body: CreateWarrantyRequest, options?: any) => Promise; /** * Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAttributes: (amazonOrderId: string, marketplaceIds: Array, options?: any) => Promise; /** * Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available message types. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessagingActionsForOrder: (amazonOrderId: string, marketplaceIds: Array, options?: any) => Promise; /** * Sends a message providing the buyer an invoice * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {InvoiceRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendInvoice: (amazonOrderId: string, marketplaceIds: Array, body: InvoiceRequest, options?: any) => Promise; }; /** * MessagingApi - functional programming interface * @export */ export declare const MessagingApiFp: (configuration?: Configuration) => { /** * Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmCustomizationDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmCustomizationDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmCustomizationDetailsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateAmazonMotorsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAmazonMotors(amazonOrderId: string, marketplaceIds: Array, body: CreateAmazonMotorsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmDeliveryDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmDeliveryDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmDeliveryDetailsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a message to ask a buyer an order-related question prior to shipping their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmOrderDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmOrderDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmOrderDetailsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmServiceDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmServiceDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmServiceDetailsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a buyer a message to share a digital access key that is required to utilize digital content in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateDigitalAccessKeyRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDigitalAccessKey(amazonOrderId: string, marketplaceIds: Array, body: CreateDigitalAccessKeyRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateLegalDisclosureRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLegalDisclosure(amazonOrderId: string, marketplaceIds: Array, body: CreateLegalDisclosureRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer\'s problem. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNegativeFeedbackRemoval(amazonOrderId: string, marketplaceIds: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateUnexpectedProblemRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUnexpectedProblem(amazonOrderId: string, marketplaceIds: Array, body: CreateUnexpectedProblemRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a message to a buyer to provide details about warranty information on a purchase in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateWarrantyRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWarranty(amazonOrderId: string, marketplaceIds: Array, body: CreateWarrantyRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAttributes(amazonOrderId: string, marketplaceIds: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available message types. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessagingActionsForOrder(amazonOrderId: string, marketplaceIds: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a message providing the buyer an invoice * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {InvoiceRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendInvoice(amazonOrderId: string, marketplaceIds: Array, body: InvoiceRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MessagingApi - factory interface * @export */ export declare const MessagingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmCustomizationDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmCustomizationDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmCustomizationDetailsRequest, options?: any): AxiosPromise; /** * Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateAmazonMotorsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAmazonMotors(amazonOrderId: string, marketplaceIds: Array, body: CreateAmazonMotorsRequest, options?: any): AxiosPromise; /** * Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmDeliveryDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmDeliveryDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmDeliveryDetailsRequest, options?: any): AxiosPromise; /** * Sends a message to ask a buyer an order-related question prior to shipping their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmOrderDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmOrderDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmOrderDetailsRequest, options?: any): AxiosPromise; /** * Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateConfirmServiceDetailsRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConfirmServiceDetails(amazonOrderId: string, marketplaceIds: Array, body: CreateConfirmServiceDetailsRequest, options?: any): AxiosPromise; /** * Sends a buyer a message to share a digital access key that is required to utilize digital content in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateDigitalAccessKeyRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDigitalAccessKey(amazonOrderId: string, marketplaceIds: Array, body: CreateDigitalAccessKeyRequest, options?: any): AxiosPromise; /** * Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateLegalDisclosureRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLegalDisclosure(amazonOrderId: string, marketplaceIds: Array, body: CreateLegalDisclosureRequest, options?: any): AxiosPromise; /** * Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer\'s problem. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createNegativeFeedbackRemoval(amazonOrderId: string, marketplaceIds: Array, options?: any): AxiosPromise; /** * Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateUnexpectedProblemRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUnexpectedProblem(amazonOrderId: string, marketplaceIds: Array, body: CreateUnexpectedProblemRequest, options?: any): AxiosPromise; /** * Sends a message to a buyer to provide details about warranty information on a purchase in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {CreateWarrantyRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWarranty(amazonOrderId: string, marketplaceIds: Array, body: CreateWarrantyRequest, options?: any): AxiosPromise; /** * Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAttributes(amazonOrderId: string, marketplaceIds: Array, options?: any): AxiosPromise; /** * Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available message types. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessagingActionsForOrder(amazonOrderId: string, marketplaceIds: Array, options?: any): AxiosPromise; /** * Sends a message providing the buyer an invoice * @param {string} amazonOrderId An Amazon order identifier. This identifies the order for which a message is sent. * @param {Array} marketplaceIds A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @param {InvoiceRequest} body This contains the message body for a message. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendInvoice(amazonOrderId: string, marketplaceIds: Array, body: InvoiceRequest, options?: any): AxiosPromise; }; /** * Request parameters for confirmCustomizationDetails operation in MessagingApi. * @export * @interface MessagingApiConfirmCustomizationDetailsRequest */ export interface MessagingApiConfirmCustomizationDetailsRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiConfirmCustomizationDetails */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiConfirmCustomizationDetails */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateConfirmCustomizationDetailsRequest} * @memberof MessagingApiConfirmCustomizationDetails */ readonly body: CreateConfirmCustomizationDetailsRequest; } /** * Request parameters for createAmazonMotors operation in MessagingApi. * @export * @interface MessagingApiCreateAmazonMotorsRequest */ export interface MessagingApiCreateAmazonMotorsRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateAmazonMotors */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateAmazonMotors */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateAmazonMotorsRequest} * @memberof MessagingApiCreateAmazonMotors */ readonly body: CreateAmazonMotorsRequest; } /** * Request parameters for createConfirmDeliveryDetails operation in MessagingApi. * @export * @interface MessagingApiCreateConfirmDeliveryDetailsRequest */ export interface MessagingApiCreateConfirmDeliveryDetailsRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateConfirmDeliveryDetails */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateConfirmDeliveryDetails */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateConfirmDeliveryDetailsRequest} * @memberof MessagingApiCreateConfirmDeliveryDetails */ readonly body: CreateConfirmDeliveryDetailsRequest; } /** * Request parameters for createConfirmOrderDetails operation in MessagingApi. * @export * @interface MessagingApiCreateConfirmOrderDetailsRequest */ export interface MessagingApiCreateConfirmOrderDetailsRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateConfirmOrderDetails */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateConfirmOrderDetails */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateConfirmOrderDetailsRequest} * @memberof MessagingApiCreateConfirmOrderDetails */ readonly body: CreateConfirmOrderDetailsRequest; } /** * Request parameters for createConfirmServiceDetails operation in MessagingApi. * @export * @interface MessagingApiCreateConfirmServiceDetailsRequest */ export interface MessagingApiCreateConfirmServiceDetailsRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateConfirmServiceDetails */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateConfirmServiceDetails */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateConfirmServiceDetailsRequest} * @memberof MessagingApiCreateConfirmServiceDetails */ readonly body: CreateConfirmServiceDetailsRequest; } /** * Request parameters for createDigitalAccessKey operation in MessagingApi. * @export * @interface MessagingApiCreateDigitalAccessKeyRequest */ export interface MessagingApiCreateDigitalAccessKeyRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateDigitalAccessKey */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateDigitalAccessKey */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateDigitalAccessKeyRequest} * @memberof MessagingApiCreateDigitalAccessKey */ readonly body: CreateDigitalAccessKeyRequest; } /** * Request parameters for createLegalDisclosure operation in MessagingApi. * @export * @interface MessagingApiCreateLegalDisclosureRequest */ export interface MessagingApiCreateLegalDisclosureRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateLegalDisclosure */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateLegalDisclosure */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateLegalDisclosureRequest} * @memberof MessagingApiCreateLegalDisclosure */ readonly body: CreateLegalDisclosureRequest; } /** * Request parameters for createNegativeFeedbackRemoval operation in MessagingApi. * @export * @interface MessagingApiCreateNegativeFeedbackRemovalRequest */ export interface MessagingApiCreateNegativeFeedbackRemovalRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateNegativeFeedbackRemoval */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateNegativeFeedbackRemoval */ readonly marketplaceIds: Array; } /** * Request parameters for createUnexpectedProblem operation in MessagingApi. * @export * @interface MessagingApiCreateUnexpectedProblemRequest */ export interface MessagingApiCreateUnexpectedProblemRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateUnexpectedProblem */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateUnexpectedProblem */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateUnexpectedProblemRequest} * @memberof MessagingApiCreateUnexpectedProblem */ readonly body: CreateUnexpectedProblemRequest; } /** * Request parameters for createWarranty operation in MessagingApi. * @export * @interface MessagingApiCreateWarrantyRequest */ export interface MessagingApiCreateWarrantyRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiCreateWarranty */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiCreateWarranty */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {CreateWarrantyRequest} * @memberof MessagingApiCreateWarranty */ readonly body: CreateWarrantyRequest; } /** * Request parameters for getAttributes operation in MessagingApi. * @export * @interface MessagingApiGetAttributesRequest */ export interface MessagingApiGetAttributesRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiGetAttributes */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiGetAttributes */ readonly marketplaceIds: Array; } /** * Request parameters for getMessagingActionsForOrder operation in MessagingApi. * @export * @interface MessagingApiGetMessagingActionsForOrderRequest */ export interface MessagingApiGetMessagingActionsForOrderRequest { /** * An Amazon order identifier. This specifies the order for which you want a list of available message types. * @type {string} * @memberof MessagingApiGetMessagingActionsForOrder */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiGetMessagingActionsForOrder */ readonly marketplaceIds: Array; } /** * Request parameters for sendInvoice operation in MessagingApi. * @export * @interface MessagingApiSendInvoiceRequest */ export interface MessagingApiSendInvoiceRequest { /** * An Amazon order identifier. This identifies the order for which a message is sent. * @type {string} * @memberof MessagingApiSendInvoice */ readonly amazonOrderId: string; /** * A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace. * @type {Array} * @memberof MessagingApiSendInvoice */ readonly marketplaceIds: Array; /** * This contains the message body for a message. * @type {InvoiceRequest} * @memberof MessagingApiSendInvoice */ readonly body: InvoiceRequest; } /** * MessagingApi - object-oriented interface * @export * @class MessagingApi * @extends {BaseAPI} */ export declare class MessagingApi extends BaseAPI { /** * Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiConfirmCustomizationDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ confirmCustomizationDetails(requestParameters: MessagingApiConfirmCustomizationDetailsRequest, options?: any): Promise>; /** * Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateAmazonMotorsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createAmazonMotors(requestParameters: MessagingApiCreateAmazonMotorsRequest, options?: any): Promise>; /** * Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateConfirmDeliveryDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createConfirmDeliveryDetails(requestParameters: MessagingApiCreateConfirmDeliveryDetailsRequest, options?: any): Promise>; /** * Sends a message to ask a buyer an order-related question prior to shipping their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateConfirmOrderDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createConfirmOrderDetails(requestParameters: MessagingApiCreateConfirmOrderDetailsRequest, options?: any): Promise>; /** * Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateConfirmServiceDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createConfirmServiceDetails(requestParameters: MessagingApiCreateConfirmServiceDetailsRequest, options?: any): Promise>; /** * Sends a buyer a message to share a digital access key that is required to utilize digital content in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateDigitalAccessKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createDigitalAccessKey(requestParameters: MessagingApiCreateDigitalAccessKeyRequest, options?: any): Promise>; /** * Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateLegalDisclosureRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createLegalDisclosure(requestParameters: MessagingApiCreateLegalDisclosureRequest, options?: any): Promise>; /** * Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer\'s problem. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateNegativeFeedbackRemovalRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createNegativeFeedbackRemoval(requestParameters: MessagingApiCreateNegativeFeedbackRemovalRequest, options?: any): Promise>; /** * Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateUnexpectedProblemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createUnexpectedProblem(requestParameters: MessagingApiCreateUnexpectedProblemRequest, options?: any): Promise>; /** * Sends a message to a buyer to provide details about warranty information on a purchase in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiCreateWarrantyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ createWarranty(requestParameters: MessagingApiCreateWarrantyRequest, options?: any): Promise>; /** * Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | * @param {MessagingApiGetAttributesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ getAttributes(requestParameters: MessagingApiGetAttributesRequest, options?: any): Promise>; /** * Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {MessagingApiGetMessagingActionsForOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ getMessagingActionsForOrder(requestParameters: MessagingApiGetMessagingActionsForOrderRequest, options?: any): Promise>; /** * Sends a message providing the buyer an invoice * @param {MessagingApiSendInvoiceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagingApi */ sendInvoice(requestParameters: MessagingApiSendInvoiceRequest, options?: any): Promise>; }