TwitterClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewTweet': {'operation_id': 'OnNewTweet', 'path': '/{connectionId}/onnewtweet', 'method': 'get', 'required_parameters': ['searchQuery'], 'callback_payload_type': 'TriggerBatchResponseTweetModel'}}

Classes

TweetModel dataclass

TweetModel(tweet_text: Optional[str] = None, tweet_id: Optional[str] = None, created_at: Optional[str] = None, created_at_iso: Optional[str] = None, retweet_count: Optional[int] = None, tweeted_by: Optional[str] = None, media_urls: Optional[List[str]] = None, tweet_language_code: Optional[str] = None, tweet_in_reply_to_user_id: Optional[str] = None, favorited: Optional[bool] = None, user_mentions: Optional[List[UserMentionsModel]] = None, original_tweet: Optional[OriginalTweetModel] = None, user_details: Optional[UserDetailsModel] = None)

Response for Get user timeline

Attributes

tweet_text class-attribute instance-attribute

tweet_text: Optional[str] = field(default=None, metadata={'wire_name': 'TweetText'})

Text content of the tweet

tweet_id class-attribute instance-attribute

tweet_id: Optional[str] = field(default=None, metadata={'wire_name': 'TweetId'})

Id of the tweet

created_at class-attribute instance-attribute

created_at: Optional[str] = field(default=None, metadata={'wire_name': 'CreatedAt'})

Time at which the tweet was posted

created_at_iso class-attribute instance-attribute

created_at_iso: Optional[str] = field(default=None, metadata={'wire_name': 'CreatedAtIso'})

Time at which the tweet was posted

retweet_count class-attribute instance-attribute

retweet_count: Optional[int] = field(default=None, metadata={'wire_name': 'RetweetCount'})

Total number of re-tweets for the tweet

tweeted_by class-attribute instance-attribute

tweeted_by: Optional[str] = field(default=None, metadata={'wire_name': 'TweetedBy'})

Name of the user who has posted the tweet

media_urls class-attribute instance-attribute

media_urls: Optional[List[str]] = field(default=None, metadata={'wire_name': 'MediaUrls'})

Url of the media posted along with the tweet

tweet_language_code class-attribute instance-attribute

tweet_language_code: Optional[str] = field(default=None, metadata={'wire_name': 'TweetLanguageCode'})

Language code of the tweet

tweet_in_reply_to_user_id class-attribute instance-attribute

tweet_in_reply_to_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'TweetInReplyToUserId'})

User Id of the author of the tweet that the current tweet is a reply to

favorited class-attribute instance-attribute

favorited: Optional[bool] = field(default=None, metadata={'wire_name': 'Favorited'})

Indicates whether the tweet is marked as favorited or not

user_mentions class-attribute instance-attribute

user_mentions: Optional[List[UserMentionsModel]] = field(default=None, metadata={'wire_name': 'UserMentions'})

List of users mentioned in the tweet

UserDetailsModel dataclass

UserDetailsModel(full_name: Optional[str] = None, location: Optional[str] = None, id: Optional[int] = None, user_name: Optional[str] = None, followers_count: Optional[int] = None, description: Optional[str] = None, statuses_count: Optional[int] = None, friends_count: Optional[int] = None, favourites_count: Optional[int] = None, profile_image_url: Optional[str] = None)

Response for Get followers

Attributes

full_name class-attribute instance-attribute

full_name: Optional[str] = field(default=None, metadata={'wire_name': 'FullName'})

Name of the user

location class-attribute instance-attribute

location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location of the user

id class-attribute instance-attribute

id: Optional[int] = field(default=None, metadata={'wire_name': 'Id'})

X id (handle) of the user

user_name class-attribute instance-attribute

user_name: Optional[str] = field(default=None, metadata={'wire_name': 'UserName'})

Screen name of the user

followers_count class-attribute instance-attribute

followers_count: Optional[int] = field(default=None, metadata={'wire_name': 'FollowersCount'})

Number of followers

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

User description

statuses_count class-attribute instance-attribute

statuses_count: Optional[int] = field(default=None, metadata={'wire_name': 'StatusesCount'})

User status count

friends_count class-attribute instance-attribute

friends_count: Optional[int] = field(default=None, metadata={'wire_name': 'FriendsCount'})

Number of friends

favourites_count class-attribute instance-attribute

favourites_count: Optional[int] = field(default=None, metadata={'wire_name': 'FavouritesCount'})

Number of tweets that the user has favorited

profile_image_url class-attribute instance-attribute

profile_image_url: Optional[str] = field(default=None, metadata={'wire_name': 'ProfileImageUrl'})

Url of the profile image

TweetResponseModel dataclass

TweetResponseModel(tweet_id: Optional[str] = None)

Response for Post a tweet

Attributes

tweet_id class-attribute instance-attribute

tweet_id: Optional[str] = field(default=None, metadata={'wire_name': 'TweetId'})

ID of the tweet posted

TriggerBatchResponseTweetModel dataclass

TriggerBatchResponseTweetModel(value: Optional[List[TweetModel]] = None)

Response for When a new tweet is posted

Attributes

value class-attribute instance-attribute

value: Optional[List[TweetModel]] = None

A list of the response objects

UserMentionsModel dataclass

UserMentionsModel(id: Optional[int] = None, full_name: Optional[str] = None, user_name: Optional[str] = None)

Definition: UserMentionsModel

Attributes

id class-attribute instance-attribute

id: Optional[int] = field(default=None, metadata={'wire_name': 'Id'})

X id (handle) of the user

full_name class-attribute instance-attribute

full_name: Optional[str] = field(default=None, metadata={'wire_name': 'FullName'})

Full name of the user

user_name class-attribute instance-attribute

user_name: Optional[str] = field(default=None, metadata={'wire_name': 'UserName'})

Screen name of the user

OriginalTweetModel dataclass

OriginalTweetModel(tweet_text: Optional[str] = None, tweet_id: Optional[str] = None, created_at: Optional[str] = None, created_at_iso: Optional[str] = None, retweet_count: Optional[int] = None, tweeted_by: Optional[str] = None, media_urls: Optional[List[str]] = None, tweet_language_code: Optional[str] = None, tweet_in_reply_to_user_id: Optional[str] = None, favorited: Optional[bool] = None, user_mentions: Optional[List[OriginalTweetUserMentionsModel]] = None, user_details: Optional[OriginalTweetUserDetailsModel] = None)

Definition: OriginalTweetModel

Attributes

tweet_text class-attribute instance-attribute

tweet_text: Optional[str] = field(default=None, metadata={'wire_name': 'TweetText'})

Text content of the original retrieved tweet

tweet_id class-attribute instance-attribute

tweet_id: Optional[str] = field(default=None, metadata={'wire_name': 'TweetId'})

Id of the original tweet

created_at class-attribute instance-attribute

created_at: Optional[str] = field(default=None, metadata={'wire_name': 'CreatedAt'})

Time at which original tweet was posted

created_at_iso class-attribute instance-attribute

created_at_iso: Optional[str] = field(default=None, metadata={'wire_name': 'CreatedAtIso'})

Time at which original tweet was posted

retweet_count class-attribute instance-attribute

retweet_count: Optional[int] = field(default=None, metadata={'wire_name': 'RetweetCount'})

Total number of re-tweets for this original tweet

tweeted_by class-attribute instance-attribute

tweeted_by: Optional[str] = field(default=None, metadata={'wire_name': 'TweetedBy'})

User name of the person who posted the original tweet

media_urls class-attribute instance-attribute

media_urls: Optional[List[str]] = field(default=None, metadata={'wire_name': 'MediaUrls'})

Url of the media posted along with the original tweet

tweet_language_code class-attribute instance-attribute

tweet_language_code: Optional[str] = field(default=None, metadata={'wire_name': 'TweetLanguageCode'})

Language code for the original tweet

tweet_in_reply_to_user_id class-attribute instance-attribute

tweet_in_reply_to_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'TweetInReplyToUserId'})

User Id of the author of the tweet that the current original tweet is a reply to

favorited class-attribute instance-attribute

favorited: Optional[bool] = field(default=None, metadata={'wire_name': 'Favorited'})

Indicates whether the original tweet is marked as favorited

user_mentions class-attribute instance-attribute

user_mentions: Optional[List[OriginalTweetUserMentionsModel]] = field(default=None, metadata={'wire_name': 'UserMentions'})

The list of user mentioned in the tweet

OriginalTweetUserMentionsModel dataclass

OriginalTweetUserMentionsModel(id: Optional[int] = None, full_name: Optional[str] = None, user_name: Optional[str] = None)

Definition: OriginalTweetUserMentionsModel

Attributes

id class-attribute instance-attribute

id: Optional[int] = field(default=None, metadata={'wire_name': 'Id'})

X id (handle) of the user

full_name class-attribute instance-attribute

full_name: Optional[str] = field(default=None, metadata={'wire_name': 'FullName'})

Full name of the user

user_name class-attribute instance-attribute

user_name: Optional[str] = field(default=None, metadata={'wire_name': 'UserName'})

Screen name of the user

OriginalTweetUserDetailsModel dataclass

OriginalTweetUserDetailsModel(full_name: Optional[str] = None, location: Optional[str] = None, id: Optional[int] = None, user_name: Optional[str] = None, followers_count: Optional[int] = None, description: Optional[str] = None, statuses_count: Optional[int] = None, friends_count: Optional[int] = None, favourites_count: Optional[int] = None, profile_image_url: Optional[str] = None)

Definition: OriginalTweetUserDetailsModel

Attributes

full_name class-attribute instance-attribute

full_name: Optional[str] = field(default=None, metadata={'wire_name': 'FullName'})

Name of the user

location class-attribute instance-attribute

location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location of the user

id class-attribute instance-attribute

id: Optional[int] = field(default=None, metadata={'wire_name': 'Id'})

X id (handle) of the user

user_name class-attribute instance-attribute

user_name: Optional[str] = field(default=None, metadata={'wire_name': 'UserName'})

Screen name of the user

followers_count class-attribute instance-attribute

followers_count: Optional[int] = field(default=None, metadata={'wire_name': 'FollowersCount'})

Number of followers

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

User description

statuses_count class-attribute instance-attribute

statuses_count: Optional[int] = field(default=None, metadata={'wire_name': 'StatusesCount'})

User status count

friends_count class-attribute instance-attribute

friends_count: Optional[int] = field(default=None, metadata={'wire_name': 'FriendsCount'})

Number of friends

favourites_count class-attribute instance-attribute

favourites_count: Optional[int] = field(default=None, metadata={'wire_name': 'FavouritesCount'})

Number of tweets that the user has favorited

profile_image_url class-attribute instance-attribute

profile_image_url: Optional[str] = field(default=None, metadata={'wire_name': 'ProfileImageUrl'})

Url of the profile image

TwitterClient

TwitterClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for twitter connector.

Initialize a TwitterClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

user_timeline_async async

user_timeline_async(user_name: str, max_results: Optional[int] = None) -> dict[str, Any] | None

Get user timeline

This operation gets a list of the most recent tweets posted by a given user.

home_timeline_async async

home_timeline_async(max_results: Optional[int] = None) -> dict[str, Any] | None

Get home timeline

This operation gets the most recent tweets and re-tweets posted by me and my followers.

search_tweet_async async

search_tweet_async(search_query: str, max_results: Optional[int] = None, since_id: Optional[str] = None) -> dict[str, Any] | None

Search tweets

This operation gets a list of relevant tweets matching the search query.

followers_async async

followers_async(user_name: str, max_results: Optional[int] = None) -> dict[str, Any] | None

Get followers

This operation gets the list of users that follow a given user.

my_followers_async async

my_followers_async(max_results: Optional[int] = None) -> dict[str, Any] | None

Get my followers

This operation gets the list of users who are following me.

following_async async

following_async(user_name: str, max_results: Optional[int] = None) -> dict[str, Any] | None

Get following

The operation gets the list of people the given user follows.

my_following_async async

my_following_async(max_results: Optional[int] = None) -> dict[str, Any] | None

Get my following

This operation gets the list of users that I am following.

user_async async

user_async(user_name: str) -> dict[str, Any] | None

Get user

This operation gets the profile details for a given user, such as user name, description, followers count, and more.

tweet_async async

tweet_async(input: bytes, tweet_text: Optional[str] = None) -> dict[str, Any] | None

Post a tweet

This operation posts a new tweet.

retweet_async async

retweet_async(tweet_id: str, trim_user: Optional[bool] = None) -> dict[str, Any] | None

Retweet

This operation retweets a tweet.