///
import type { TweetV2, ApiV2Includes, MediaObjectV2, PlaceV2, PollV2 } from './tweet.definition.v2';
import type { TypeOrArrayOf } from '../shared.types';
import type { DataAndIncludeV2, DataAndMetaV2, DataMetaAndIncludeV2, DataV2, MetaV2 } from './shared.v2.types';
import type { UserV2 } from './user.v2.types';
import { PaginableCountMetaV2 } from './shared.v2.types';
export interface TweetV2TimelineParams extends Partial {
/** ISO date string */
end_time?: string;
/** ISO date string */
start_time?: string;
max_results?: number;
since_id?: string;
until_id?: string;
next_token?: string;
}
export interface Tweetv2SearchParams extends TweetV2TimelineParams {
query: string;
sort_order?: 'recency' | 'relevancy';
}
export interface TweetV2PaginableTimelineParams extends TweetV2TimelineParams {
pagination_token?: string;
}
export interface TweetV2PaginableListParams extends Partial {
pagination_token?: string;
max_results?: number;
}
export interface TweetV2UserTimelineParams extends TweetV2PaginableTimelineParams {
exclude?: TypeOrArrayOf<'retweets' | 'replies'>;
}
export interface TweetV2HomeTimelineParams extends TweetV2UserTimelineParams {
}
export declare type TTweetv2Expansion = 'attachments.poll_ids' | 'attachments.media_keys' | 'attachments.media_source_tweet' | 'author_id' | 'referenced_tweets.id' | 'in_reply_to_user_id' | 'edit_history_tweet_ids' | 'geo.place_id' | 'entities.mentions.username' | 'referenced_tweets.id.author_id' | 'article.cover_media' | 'article.media_entities' | 'entities.note.mentions.username' | 'referenced_tweets.id.attachments.media_keys';
export declare type TTweetv2MediaField = keyof MediaObjectV2;
export declare type TTweetv2PlaceField = keyof PlaceV2;
export declare type TTweetv2PollField = keyof PollV2;
export declare type TTweetv2TweetField = keyof TweetV2;
export declare type TTweetv2UserField = keyof UserV2;
export interface Tweetv2FieldsParams {
expansions: TypeOrArrayOf | string;
'media.fields': TypeOrArrayOf | string;
'place.fields': TypeOrArrayOf | string;
'poll.fields': TypeOrArrayOf | string;
'tweet.fields': TypeOrArrayOf | string;
'user.fields': TypeOrArrayOf | string;
}
export interface TweetSearchV2StreamParams extends Tweetv2FieldsParams {
backfill_minutes: number;
}
export interface TweetV2CountParams {
query: string;
end_time?: string;
start_time?: string;
until_id?: string;
since_id?: string;
granularity?: 'day' | 'hour' | 'minute';
}
export interface TweetV2CountAllParams extends TweetV2CountParams {
next_token: string;
}
export declare type TweetV2CountResult = DataAndMetaV2<{
start: string;
end: string;
tweet_count: number;
}[], {
total_tweet_count: number;
}>;
export declare type TweetV2CountAllResult = TweetV2CountResult & MetaV2<{
next_token: string;
}>;
export declare type Tweetv2TimelineResult = DataMetaAndIncludeV2;
export declare type Tweetv2ListResult = DataMetaAndIncludeV2;
export declare type Tweetv2SearchResult = Tweetv2TimelineResult;
export declare type TweetV2PaginableTimelineResult = Tweetv2TimelineResult & MetaV2<{
previous_token?: string;
}>;
export declare type TweetV2UserTimelineResult = TweetV2PaginableTimelineResult;
export declare type TweetV2HomeTimelineResult = TweetV2PaginableTimelineResult;
export declare type TweetV2LookupResult = DataAndIncludeV2;
export declare type TweetV2SingleResult = DataAndIncludeV2;
export declare type TweetV2SingleStreamResult = TweetV2SingleResult & {
matching_rules: {
id: string | number;
tag: string;
}[];
};
export declare type TweetV2PostTweetResult = DataV2<{
id: string;
text: string;
}>;
export declare type TweetV2HideReplyResult = DataV2<{
hidden: boolean;
}>;
export declare type TweetV2LikeResult = DataV2<{
liked: boolean;
}>;
export declare type TweetV2LikedByResult = DataMetaAndIncludeV2;
export declare type TweetV2RetweetResult = DataV2<{
retweeted: boolean;
}>;
export declare type TweetV2RetweetedByResult = TweetV2LikedByResult;
export declare type TweetV2BookmarkResult = DataV2<{
bookmarked: boolean;
}>;
export declare type TweetV2DeleteTweetResult = DataV2<{
deleted: boolean;
}>;
export interface BatchComplianceJobV2 {
resumable: false;
type: 'tweets' | 'users';
download_expires_at: string;
created_at: string;
upload_url: string;
download_url: string;
id: string;
status: 'created' | 'complete' | 'in_progress' | 'expired' | 'failed';
upload_expires_at: string;
error?: string;
}
export interface BatchComplianceSearchV2Params {
type: 'tweets' | 'users';
status?: 'created' | 'complete' | 'in_progress' | 'expired' | 'failed';
}
export interface BatchComplianceV2Params {
type: 'tweets' | 'users';
name?: string;
ids: string[] | Buffer;
}
export interface BatchComplianceV2JobResult {
id: string;
action: 'delete';
created_at: string;
redacted_at?: string;
reason: 'deleted' | 'suspended' | 'protected' | 'scrub_geo' | 'deactivated';
}
export declare type BatchComplianceListV2Result = DataV2;
export declare type BatchComplianceV2Result = DataV2;
declare type TUsageField = 'cap_reset_day' | 'daily_client_app_usage' | 'daily_project_usage' | 'project_cap' | 'project_id' | 'project_usage';
export declare type TweetUsageV2Params = {
days?: number;
'usage.fields'?: TUsageField[];
};
declare type TUsageDaily = {
/** ISO date string */
date: string;
usage: string;
};
export declare type TweetV2UsageResult = DataV2<{
project_id?: string;
project_cap?: string;
project_usage?: string;
cap_reset_day?: number;
daily_project_usage?: {
project_id: string;
usage: TUsageDaily[];
}[];
daily_client_app_usage?: {
usage: TUsageDaily[];
}[];
}>;
export {};