import { CustomProfilesByIdParams } from '../interfaces/params/CustomProfilesParams'; import { EventsDestroyParams, EventsShowParams, EventsListParams, EventsNewParams } from '../interfaces/params/SendingAndReceivingEventsParams'; import { IndicateTypingParams } from '../interfaces/params/TypingIndicatorAndReadReceiptsParams'; import { WelcomeMessagesRulesShowParams, WelcomeMessagesShowParams, WelcomeMessagesNewParams, WelcomeMessagesRulesNewParams, WelcomeMessagesListParams, WelcomeMessagesDestroyParams, WelcomeMessagesRulesDestroyParams } from '../interfaces/params/WelcomeMessagesParams'; import CustomProfilesById from '../interfaces/types/CustomProfilesByIdTypes'; import EventsShow from '../interfaces/types/EventsShowTypes'; import EventsNew from '../interfaces/types/EventsNewTypes'; import WelcomeMessagesRulesShow from '../interfaces/types/WelcomeMessagesRulesShowTypes'; import WelcomeMessagesShow from '../interfaces/types/WelcomeMessagesShowTypes'; import WelcomeMessagesNew from '../interfaces/types/WelcomeMessagesNewTypes'; import WelcomeMessagesRulesNew from '../interfaces/types/WelcomeMessagesRulesNewTypes'; import WelcomeMessagesList from '../interfaces/types/WelcomeMessagesListTypes'; import Transport from '../base/Transport'; declare class DirectMessagesClient { private transport; constructor(transport: Transport); /** * Returns a custom profile that was created with POST custom_profiles/new.json. * * @link https://developer.twitter.com/en/docs/direct-messages/custom-profiles/api-reference/get-profile * @param parameters */ customProfilesById(parameters: CustomProfilesByIdParams): Promise; /** * Deletes the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message. Direct Messages are only removed from the interface of the user context provided. Other members of the conversation can still access the Direct Messages. A successful delete will return a 204 http response code with no body content. Important: This method requires an access token with RWD (read, write & direct message) permissions. * * @link https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message-event * @param parameters */ eventsDestroy(parameters: EventsDestroyParams): Promise; /** * Returns a single Direct Message event by the given id. * * @link https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-event * @param parameters */ eventsShow(parameters: EventsShowParams): Promise; /** * Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order. * * @link https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/list-events * @param parameters */ eventsList(parameters?: EventsListParams): Promise; /** * Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user. Returns an event if successful. Supports publishing Direct Messages with optional Quick Reply and media attachment. Replaces behavior currently provided by POST direct_messages/new.Requires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically. * * @link https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event * @param parameters */ eventsNew(parameters: EventsNewParams): Promise; /** * Displays a visual typing indicator in the recipient’s Direct Message conversation view with the sender. Each request triggers a typing indicator animation with a duration of ~3 seconds. * * @link https://developer.twitter.com/en/docs/direct-messages/typing-indicator-and-read-receipts/api-reference/new-typing-indicator * @param parameters */ indicateTyping(parameters: IndicateTypingParams): Promise; /** * Returns a Welcome Message Rule by the given id. * * @link https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message-rule * @param parameters */ welcomeMessagesRulesShow(parameters: WelcomeMessagesRulesShowParams): Promise; /** * Returns a Welcome Message by the given id. * * @link https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message * @param parameters */ welcomeMessagesShow(parameters: WelcomeMessagesShowParams): Promise; /** * Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances. Returns the message template if successful. Supports publishing with the same elements as Direct Messages (e.g. Quick Replies, media attachments). Requires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically. See the Welcome Messages overview to learn how to work with Welcome Messages. * * @link https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message * @param parameters */ welcomeMessagesNew(parameters: WelcomeMessagesNewParams): Promise; /** * Creates a new Welcome Message Rule that determines which Welcome Message will be shown in a given conversation. Returns the created rule if successful. Requires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically. Additional rule configurations are forthcoming. For the initial beta release, the most recently created Rule will always take precedence, and the assigned Welcome Message will be displayed in the conversation.See the Welcome Messages overview to learn how to work with Welcome Messages. * * @link https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message-rule * @param parameters */ welcomeMessagesRulesNew(parameters: WelcomeMessagesRulesNewParams): Promise; /** * Returns a list of Welcome Messages. * * @link https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/welcome-messages/api-reference/list-welcome-messages * @param parameters */ welcomeMessagesList(parameters?: WelcomeMessagesListParams): Promise; /** * Returns a list of Welcome Messages. * * @link https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/welcome-messages/api-reference/delete-welcome-message * @param parameters */ welcomeMessagesDestroy(parameters: WelcomeMessagesDestroyParams): Promise; /** * Returns a list of Welcome Messages. * * @link https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/welcome-messages/api-reference/delete-welcome-message-rule * @param parameters */ welcomeMessagesRulesDestroy(parameters: WelcomeMessagesRulesDestroyParams): Promise; } export default DirectMessagesClient;