resources

Documentation

Index

• type Annotation
• type Compliance
• type ComplianceType
• type ContextAnnotation
• type CreateSearchStreamRulesMeta
• type CreateSearchStreamRulesMetaSummary
• type DeleteSearchStreamRulesMeta
• type DeleteSearchStreamRulesMetaSummary
• type ErrorCode
  • func (e ErrorCode) Detail() *ErrorCodeDetail
• type ErrorCodeDetail
• type ErrorInformation
• type FilterdStreamRule
• type Geo
• type IncludeGeo
• type IncludeVariant
• type List
• type ListFollowsFollowedListsMeta
• type ListFollowsFollowersMeta
• type ListLookupOwnedListsMeta
• type ListMembersGetMeta
• type ListMembersListMembershipsMeta
• type ListSearchStreamRulesMeta
• type ListTweetsLookupMeta
• type Media
• type Non2XXError
• type NonPublicMetrics
• type OrganicMetrics
• type PaginationMeta
• type PartialError
• type Place
• type Poll
• type PollOption
• type PromotedMetrics
• type QuoteTweetsMeta
• type ReferencedTweet
• type Space
• type SpacesLookupByCreatorsIDsMeta
• type SpacesLookupTweetsMeta
• type Tweet
• type TweetAttachments
• type TweetCount
• type TweetCountAllMeta
• type TweetCountRecentMeta
• type TweetEntities
• type TweetEntityTag
• type TweetNoteTweet
• type TweetPublicMetrics
• type TweetTimelineMeta
• type TweetWithheld
• type URL
• type URLImage
• type User
• type UserDescription
• type UserEntities
• type UserEntityTag
• type UserPublicMetrics
• type UserURL
• type UserWithheld

Types

type Annotation

type Annotation struct {
	Start          *int     `json:"start"`
	End            *int     `json:"end"`
	Probability    *float64 `json:"probability"`
	Type           *string  `json:"type"`
	NormalizedText *string  `json:"normalized_text"`
}

type Compliance

type Compliance struct {
	ID                string         `json:"id"`
	Resumable         bool           `json:"resumable"`
	Status            string         `json:"status"`
	CreatedAt         *time.Time     `json:"created_at"`
	Type              ComplianceType `json:"type"`
	Name              string         `json:"name"`
	UploadURL         string         `json:"upload_url"`
	UploadExpiresAt   *time.Time     `json:"upload_expires_at"`
	DownloadURL       string         `json:"download_url"`
	DownloadExpiresAt *time.Time     `json:"download_expires_at"`
}

type ComplianceType

type ComplianceType string

const (
	ComplianceTypeTweets ComplianceType = "tweets"
	ComplianceTypeUsers  ComplianceType = "users"
)

type ContextAnnotation

type ContextAnnotation struct {
	Domain struct {
		ID          *string `json:"id"`
		Name        *string `json:"name"`
		Description *string `json:"description"`
	} `json:"domain"`
	Entity struct {
		ID   *string `json:"id"`
		Name *string `json:"name"`
	}
}

type CreateSearchStreamRulesMeta

type CreateSearchStreamRulesMeta struct {
	Sent    *time.Time                         `json:"sent"`
	Summary CreateSearchStreamRulesMetaSummary `json:"summary"`
}

type CreateSearchStreamRulesMetaSummary

type CreateSearchStreamRulesMetaSummary struct {
	Created    int `json:"created"`
	NotCreated int `json:"not_created"`
}

type DeleteSearchStreamRulesMeta

type DeleteSearchStreamRulesMeta struct {
	Sent    *time.Time                         `json:"sent"`
	Summary DeleteSearchStreamRulesMetaSummary `json:"summary"`
}

type DeleteSearchStreamRulesMetaSummary

type DeleteSearchStreamRulesMetaSummary struct {
	Deleted    int `json:"deleted"`
	NotDeleted int `json:"not_deleted"`
}

type ErrorCode

type ErrorCode int

func (ErrorCode) Detail

func (e ErrorCode) Detail() *ErrorCodeDetail

type ErrorCodeDetail

type ErrorCodeDetail struct {
	Text        string
	Description string
}

type ErrorInformation

type ErrorInformation struct {
	Message    string              `json:"message"`
	Code       ErrorCode           `json:"code,omitempty"`
	Label      string              `json:"label,omitempty"`
	Parameters map[string][]string `json:"parameters,omitempty"`
}

type FilterdStreamRule

type FilterdStreamRule struct {
	ID    *string `json:"id"`
	Value *string `json:"value"`
	Tag   *string `json:"tag"`
}

type Geo

type Geo struct {
	Coordinates struct {
		Type        *string `json:"type"`
		Coordinates []*int  `json:"coordinates"`
	} `json:"coordinates"`
	PlaceID *string `json:"place_id"`
}

type IncludeGeo

type IncludeGeo struct {
	Type       *string     `json:"type"`
	BBox       [4]*float64 `json:"bbox"`
	Properties interface{} `json:"properties"`
}

type IncludeVariant

type IncludeVariant struct {
	BitRate     int    `json:"bit_rate"`
	ContentType string `json:"content_type"`
	URL         string `json:"url"`
}

type List

type List struct {
	ID            *string    `json:"id"`
	Name          *string    `json:"name"`
	CreatedAt     *time.Time `json:"created_at,omitempty"`
	Private       *bool      `json:"private,omitempty"`
	FollowerCount *int       `json:"follower_count,omitempty"`
	MemberCount   *int       `json:"member_count,omitempty"`
	OwnerID       *string    `json:"owner_id,omitempty"`
	Description   *string    `json:"description,omitempty"`
}

type ListFollowsFollowedListsMeta

type ListFollowsFollowedListsMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type ListFollowsFollowersMeta

type ListFollowsFollowersMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type ListLookupOwnedListsMeta

type ListLookupOwnedListsMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type ListMembersGetMeta

type ListMembersGetMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type ListMembersListMembershipsMeta

type ListMembersListMembershipsMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type ListSearchStreamRulesMeta

type ListSearchStreamRulesMeta struct {
	Sent *time.Time `json:"sent"`
}

type ListTweetsLookupMeta

type ListTweetsLookupMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type Media

type Media struct {
	MediaKey         *string          `json:"media_key"`
	Type             *string          `json:"type"`
	DurationMs       *int             `json:"duration_ms,omitempty"`
	Height           *int             `json:"height,omitempty"`
	NonPublicMetrics map[string]*int  `json:"non_public_metrics,omitempty"`
	OrganicMetrics   map[string]*int  `json:"organic_metrics,omitempty"`
	URL              *string          `json:"url,omitempty"`
	PreviewImageUrl  *string          `json:"preview_image_url,omitempty"`
	PromotedMetrics  map[string]*int  `json:"promoted_metrics,omitempty"`
	PublicMetrics    map[string]*int  `json:"public_metrics,omitempty"`
	Width            *int             `json:"width,omitempty"`
	AltText          *int             `json:"alt_text,omitempty"`
	Variants         []IncludeVariant `json:"variants,omitempty"`
}

type Non2XXError

type Non2XXError struct {
	APIErrors     []ErrorInformation         `json:"errors"`
	Title         string                     `json:"title,omitempty"`
	Detail        string                     `json:"detail,omitempty"`
	Type          string                     `json:"type,omitempty"`
	Status        string                     `json:"-"`
	StatusCode    int                        `json:"-"`
	RateLimitInfo *util.RateLimitInformation `json:"-"`
}

type NonPublicMetrics

type NonPublicMetrics struct {
	ImpressionCount   *int `json:"impression_count"`
	UrlLinkClicks     *int `json:"url_link_clicks"`
	UserProfileClicks *int `json:"user_profile_clicks"`
}

type OrganicMetrics

type OrganicMetrics struct {
	ImpressionCount   *int `json:"impression_count"`
	LikeCount         *int `json:"like_count"`
	ReplyCount        *int `json:"reply_count"`
	RetweetCount      *int `json:"retweet_count"`
	UrlLinkClicks     *int `json:"url_link_clicks"`
	UserProfileClicks *int `json:"user_profile_clicks"`
}

type PaginationMeta

type PaginationMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type PartialError

type PartialError struct {
	ResourceType *string `json:"resource_type"`
	Field        *string `json:"field"`
	Parameter    *string `json:"parameter"`
	ResourceID   *string `json:"resource_id"`
	Title        *string `json:"title"`
	Section      *string `json:"section"`
	Detail       *string `json:"detail"`
	Value        *string `json:"value"`
	Type         *string `json:"type"`
}

type Place

type Place struct {
	FullName        *string     `json:"full_name"`
	ID              *string     `json:"id"`
	ContainedWithin *string     `json:"contained_within,omitempty"`
	Country         *string     `json:"country,omitempty"`
	CountryCode     *string     `json:"country_code,omitempty"`
	Geo             *IncludeGeo `json:"geo,omitempty"`
	Name            *string     `json:"name,omitempty"`
	PlaceType       *string     `json:"place_type,omitempty"`
}

type Poll

type Poll struct {
	ID              *string      `json:"id"`
	Options         []PollOption `json:"options"`
	DurationMinutes *int         `json:"duration_minutes,omitempty"`
	EndDatetime     *time.Time   `json:"end_datetime,omitempty"`
	VotingStatus    *string      `json:"voting_status,omitempty"`
}

type PollOption

type PollOption struct {
	Position *int    `json:"position"`
	Label    *string `json:"label"`
	Votes    *int    `json:"votes"`
}

type PromotedMetrics

type PromotedMetrics struct {
	ImpressionCount   *int `json:"impression_count"`
	LikeCount         *int `json:"like_count"`
	ReplyCount        *int `json:"reply_count"`
	RetweetCount      *int `json:"retweet_count"`
	UrlLinkClicks     *int `json:"url_link_clicks"`
	UserProfileClicks *int `json:"user_profile_clicks"`
}

type QuoteTweetsMeta

type QuoteTweetsMeta struct {
	ResultCount   *int    `json:"result_count"`
	NextToken     *string `json:"next_token,omitempty"`
	PreviousToken *string `json:"previous_token,omitempty"`
}

type ReferencedTweet

type ReferencedTweet struct {
	Type *string `json:"type"`
	ID   *string `json:"id"`
}

type Space

type Space struct {
	ID               *string    `json:"id"`
	HostIDs          []*string  `json:"host_ids,omitempty"`
	CreatorID        *string    `json:"creator_id,omitempty"`
	Lang             *string    `json:"lang,omitempty"`
	IsTicketed       *bool      `json:"is_ticketed,omitempty"`
	InvitedUserIDs   []*string  `json:"invited_user_ids,omitempty"`
	ParticipantCount *int       `json:"participant_count,omitempty"`
	SpeakerIDs       []*string  `json:"speaker_ids,omitempty"`
	State            *string    `json:"state"`
	Title            *string    `json:"title,omitempty"`
	ScheduledStart   *time.Time `json:"scheduled_start,omitempty"`
	CreatedAt        *time.Time `json:"created_at,omitempty"`
	StartedAt        *time.Time `json:"started_at,omitempty"`
	UpdatedAt        *time.Time `json:"updated_at,omitempty"`
}

type SpacesLookupByCreatorsIDsMeta

type SpacesLookupByCreatorsIDsMeta struct {
	ResultCount *int `json:"result_count"`
}

type SpacesLookupTweetsMeta

type SpacesLookupTweetsMeta struct {
	ResultCount *int `json:"result_count"`
}

type Tweet

type Tweet struct {
	ID                  *string             `json:"id"`
	Text                *string             `json:"text"`
	EditHistoryTweetIDs []*string           `json:"edit_history_tweet_ids"`
	Attachments         *TweetAttachments   `json:"attachments,omitempty"`
	AuthorID            *string             `json:"author_id,omitempty"`
	ContextAnnotations  []ContextAnnotation `json:"context_annotations,omitempty"`
	ConversationID      *string             `json:"conversation_id,omitempty"`
	CreatedAt           *time.Time          `json:"created_at,omitempty"`
	Entities            *TweetEntities      `json:"entities,omitempty"`
	Geo                 *Geo                `json:"geo,omitempty"`
	InReplyToUserID     *string             `json:"in_reply_to_user_id,omitempty"`
	Lang                *string             `json:"lang,omitempty"`
	NonPublicMetrics    *NonPublicMetrics   `json:"non_public_metrics,omitempty"`
	OrganicMetrics      *OrganicMetrics     `json:"organic_metrics,omitempty"`
	PossiblySensitive   *bool               `json:"possibly_sensitive,omitempty"`
	PromotedMetrics     *PromotedMetrics    `json:"promoted_metrics,omitempty"`
	PublicMetrics       *TweetPublicMetrics `json:"public_metrics,omitempty"`
	ReferencedTweets    []ReferencedTweet   `json:"referenced_tweets,omitempty"`
	ReplySettings       *string             `json:"reply_settings,omitempty"`
	Source              *string             `json:"source,omitempty"`
	Withheld            *TweetWithheld      `json:"withheld,omitempty"`
	NoteTweet           *TweetNoteTweet     `json:"note_tweet,omitempty"`
}

type TweetAttachments

type TweetAttachments struct {
	MediaKeys []string `json:"media_keys,omitempty"`
	PollIDs   []string `json:"poll_i_ds,omitempty"`
}

type TweetCount

type TweetCount struct {
	End        *time.Time `json:"end"`
	Start      *time.Time `json:"start"`
	TweetCount *int       `json:"tweet_count"`
}

type TweetCountAllMeta

type TweetCountAllMeta struct {
	TotalTweetCount *int    `json:"total_tweet_count"`
	NextToken       *string `json:"next_token"`
}

type TweetCountRecentMeta

type TweetCountRecentMeta struct {
	TotalTweetCount *int `json:"total_tweet_count"`
}

type TweetEntities

type TweetEntities struct {
	Annotations []Annotation     `json:"annotations"`
	CashTags    []TweetEntityTag `json:"cashtags"`
	HashTags    []TweetEntityTag `json:"hashtags"`
	Mentions    []TweetEntityTag `json:"mentions"`
	URLs        []URL            `json:"urls"`
}

type TweetEntityTag

type TweetEntityTag struct {
	Start *int    `json:"start"`
	End   *int    `json:"end"`
	Tag   *string `json:"tag"`
}

type TweetNoteTweet

type TweetNoteTweet struct {
	Entities struct {
		CashTags []TweetEntityTag `json:"cashtags"`
		HashTags []TweetEntityTag `json:"hashtags"`
		Mentions []TweetEntityTag `json:"mentions"`
		URLs     []URL            `json:"urls"`
	} `json:"entities"`
	Text *string `json:"text"`
}

type TweetPublicMetrics

type TweetPublicMetrics struct {
	RetweetCount *int `json:"retweet_count"`
	ReplyCount   *int `json:"reply_count"`
	LikeCount    *int `json:"like_count"`
	QuoteCount   *int `json:"quote_count"`
}

type TweetTimelineMeta

type TweetTimelineMeta struct {
	ResultCount   *int    `json:"result_count"`
	NewestID      *string `json:"newest_id"`
	OldestID      *string `json:"oldest_id"`
	NextToken     *string `json:"next_token"`
	PreviousToken *string `json:"previous_token"`
}

type TweetWithheld

type TweetWithheld struct {
	Copyright    *bool     `json:"copyright"`
	CountryCodes []*string `json:"country_codes"`
}

type URL

type URL struct {
	Start       *int       `json:"start"`
	End         *int       `json:"end"`
	URL         *string    `json:"url"`
	ExpandedURL *string    `json:"expanded_url"`
	DisplayURL  *string    `json:"display_url"`
	Images      []URLImage `json:"images"`
	Status      *int       `json:"status"`
	Title       *string    `json:"title"`
	Description *string    `json:"description"`
	UnwoundURL  *string    `json:"unwound_url"`
}

type URLImage

type URLImage struct {
	URL    *string `json:"url"`
	Width  *int    `json:"width"`
	Height *int    `json:"height"`
}

type User

type User struct {
	ID              *string            `json:"id"`
	Name            *string            `json:"name"`
	Username        *string            `json:"username"`
	CreatedAt       *time.Time         `json:"created_at,omitempty"`
	Description     *string            `json:"description,omitempty"`
	Entities        *UserEntities      `json:"entities,omitempty"`
	Location        *string            `json:"location,omitempty"`
	PinnedTweetID   *string            `json:"pinned_tweet_id,omitempty"`
	ProfileImageURL *string            `json:"profile_image_url,omitempty"`
	Protected       *bool              `json:"protected,omitempty"`
	PublicMetrics   *UserPublicMetrics `json:"public_metrics,omitempty"`
	URL             *string            `json:"url,omitempty"`
	Verified        *bool              `json:"verified,omitempty"`
	Withheld        *UserWithheld      `json:"withheld,omitempty"`
}

type UserDescription

type UserDescription struct {
	URLs []struct {
		Start       *int    `json:"start"`
		End         *int    `json:"end"`
		URL         *string `json:"url"`
		ExpandedURL *string `json:"expanded_url"`
		DisplayURL  *string `json:"display_url"`
	} `json:"urls"`
	HashTags []UserEntityTag `json:"hashtags"`
	Mentions []UserEntities  `json:"mentions"`
	CashTags []UserEntityTag `json:"cashtags"`
}

type UserEntities

type UserEntities struct {
	URL         *UserURL         `json:"url"`
	Description *UserDescription `json:"description"`
}

type UserEntityTag

type UserEntityTag struct {
	Start *int    `json:"start"`
	End   *int    `json:"end"`
	Tag   *string `json:"tag"`
}

type UserPublicMetrics

type UserPublicMetrics struct {
	FollowersCount *int `json:"followers_count"`
	FollowingCount *int `json:"following_count"`
	TweetCount     *int `json:"tweet_count"`
	ListedCount    *int `json:"listed_count"`
}

type UserURL

type UserURL struct {
	URLs []struct {
		Start       *int    `json:"start"`
		End         *int    `json:"end"`
		URL         *string `json:"url"`
		ExpandedURL *string `json:"expanded_url"`
		DisplayURL  *string `json:"display_url"`
	} `json:"urls"`
}

type UserWithheld

type UserWithheld struct {
	Copyright    *bool     `json:"copyright"`
	CountryCodes []*string `json:"country_codes"`
}