twitter-api-client
Version:
Node.js / JavaScript client for Twitter API
151 lines (135 loc) • 5.96 kB
TypeScript
export interface StatusesHomeTimelineParams {
/**
* Specifies the number of records to retrieve. Must be less than
or equal to 200. Defaults to 20. The value of count is best thought of as
a limit to the number of tweets to return because suspended or deleted content
is removed after the count has been applied.
*/
'count'?: string | number;
/**
* Returns results with an ID greater than (that is, more recent
than) the specified ID. There are limits to the number of Tweets which can
be accessed through the API. If the limit of Tweets has occured since the
since_id, the since_id will be forced to the oldest ID available.
*/
'since_id'?: string | number;
/**
* Returns results with an ID less than (that is, older than) or
equal to the specified ID.
*/
'max_id'?: string | number;
/**
* When set to either true , t or 1 , each Tweet returned in a timeline
will include a user object including only the status authors numerical ID.
Omit this parameter to receive the complete user object.
*/
'trim_user'?: boolean;
/**
* This parameter will prevent replies from appearing in the returned
timeline. Using exclude_replies with the count parameter will mean you will
receive up-to count Tweets — this is because the count parameter retrieves
that many Tweets before filtering out retweets and replies.
*/
'exclude_replies'?: boolean;
/**
* The entities node will not be included when set to false.
*/
'include_entities'?: boolean;
/**
* This parameter enables developers to request a series of different extended fields introduced in the years since statuses/show and statuses/lookup were introduced. It has been replaced with the fields and expansions functionality.
*/
'tweet_mode'?: string;
}
export interface StatusesMentionsTimelineParams {
/**
* Specifies the number of Tweets to try and retrieve, up to a maximum
of 200. The value of count is best thought of as a limit to the number of
tweets to return because suspended or deleted content is removed after the
count has been applied. We include retweets in the count, even if include_rts
is not supplied. It is recommended you always send include_rts=1 when using
this API method.
*/
'count'?: string | number;
/**
* Returns results with an ID greater than (that is, more recent
than) the specified ID. There are limits to the number of Tweets which can
be accessed through the API. If the limit of Tweets has occured since the
since_id, the since_id will be forced to the oldest ID available.
*/
'since_id'?: string | number;
/**
* Returns results with an ID less than (that is, older than) or
equal to the specified ID.
*/
'max_id'?: string | number;
/**
* When set to either true , t or 1 , each tweet returned in a timeline
will include a user object including only the status authors numerical ID.
Omit this parameter to receive the complete user object.
*/
'trim_user'?: boolean;
/**
* The entities node will not be included when set to false.
*/
'include_entities'?: boolean;
/**
* This parameter enables developers to request a series of different extended fields introduced in the years since statuses/show and statuses/lookup were introduced. It has been replaced with the fields and expansions functionality.
*/
'tweet_mode'?: string;
}
export interface StatusesUserTimelineParams {
/**
* The ID of the user for whom to return results.
*/
'user_id'?: string | number;
/**
* The screen name of the user for whom to return results.
*/
'screen_name'?: string;
/**
* Returns results with an ID greater than (that is, more recent
than) the specified ID. There are limits to the number of Tweets that can
be accessed through the API. If the limit of Tweets has occured since the
since_id, the since_id will be forced to the oldest ID available.
*/
'since_id'?: string | number;
/**
* Specifies the number of Tweets to try and retrieve, up to a maximum
of 200 per distinct request. The value of count is best thought of as a
limit to the number of Tweets to return because suspended or deleted content
is removed after the count has been applied. We include retweets in the
count, even if include_rts is not supplied. It is recommended you always
send include_rts=1 when using this API method.
*/
'count'?: string | number;
/**
* Returns results with an ID less than (that is, older than) or
equal to the specified ID.
*/
'max_id'?: string | number;
/**
* When set to either true , t or 1 , each Tweet returned in a timeline
will include a user object including only the status authors numerical ID.
Omit this parameter to receive the complete user object.
*/
'trim_user'?: boolean;
/**
* This parameter will prevent replies from appearing in the returned
timeline. Using exclude_replies with the count parameter will mean you will
receive up-to count tweets — this is because the count parameter retrieves
that many Tweets before filtering out retweets and replies.
*/
'exclude_replies'?: boolean;
/**
* When set to false , the timeline will strip any native retweets
(though they will still count toward both the maximal length of the timeline
and the slice selected by the count parameter). Note: If you''re using the
trim_user parameter in conjunction with include_rts, the retweets will still
contain a full user object.
*/
'include_rts'?: boolean;
/**
* This parameter enables developers to request a series of different extended fields introduced in the years since statuses/show and statuses/lookup were introduced. It has been replaced with the fields and expansions functionality.
*/
'tweet_mode'?: string;
}