entities

Documentation

Index

• type Annotation
• type ComplianceJob
• type ComplianceType
• type ContextAnnotation
• type ErrorCode
  • func (e ErrorCode) Detail() *ErrorCodeDetail
• type ErrorCodeDetail
• type ErrorInformation
• type Geo
• type Non2XXError
• type NonPublicMetrics
• type OrganicMetrics
• type PartialError
• type PromotedMetrics
• type ReferencedTweet
• type Space
• type Tweet
• type TweetEntities
• type TweetEntityTag
• type TweetPublicMetrics
• type TweetWithheld
• type URL
• 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 ComplianceJob

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

type ComplianceType

type ComplianceType string

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

type ContextAnnotation

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

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 Geo

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

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:"-"`
}

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 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 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 ReferencedTweet

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

type Space

type Space struct {
	ID               string    `json:"id"`
	State            string    `json:"state"` // It's a enum actually, not a string, so maybe we should parse it
	CreatorID        string    `json:"creator_id,omitempty"`
	Title            string    `json:"title,omitempty"`
	Lang             string    `json:"lang,omitempty"`
	HostIDs          []string  `json:"host_ids,omitempty"`
	InvitedUserIDs   []string  `json:"invited_user_ids,omitempty"`
	SpeakerIDs       []string  `json:"speaker_ids,omitempty"`
	IsTicketed       bool      `json:"is_ticketed,omitempty"`
	SubscriberCount  int       `json:"subscriber_count,omitempty"`
	ParticipantCount int       `json:"participant_count,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"`
	EndedAt          time.Time `json:"ended_at,omitempty"`
}

type Tweet

type Tweet struct {
	ID                 string                         `json:"id"`
	Text               string                         `json:"text"`
	CreatedAt          time.Time                      `json:"created_at,omitempty"`
	AuthorID           string                         `json:"author_id,omitempty"`
	ConversationID     string                         `json:"conversation_id,omitempty"`
	InReplyToUserID    string                         `json:"in_reply_to_user_id,omitempty"`
	Attachments        map[string][]string            `json:"attachments,omitempty"`
	ContextAnnotations []map[string]ContextAnnotation `json:"context_annotations,omitempty"`
	Entities           TweetEntities                  `json:"entities,omitempty"`
	Geo                Geo                            `json:"geo,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"`
}

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 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 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"`
	Status      string `json:"status"`
	Title       string `json:"title"`
	Description string `json:"description"`
	UnwoundURL  string `json:"unwound_url"`
}

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"`
}