gtw

README

exvi/gtw

Minimalistic Go library for Twitter v1.1/v2 API integration. Includes only certain methods I needed. It is easy to implement new endpoints if it's necessary.

Documentation

Index

• func BoolValue(b *bool) bool
• func Float64Value(f *float64) float64
• func IntValue(i *int) int
• func StringValue(s *string) string
• func TimeValue(t *time.Time) time.Time
• type Client
  • func NewClient(apiToken string) *Client
  • func (c *Client) Request(ctx context.Context, method, path string, params Parameters, resp interface{}) error
  • func (c *Client) TweetRetweetedByUsers(ctx context.Context, tweetID string) ([]User, error)
  • func (c *Client) UserFriendshipShow(ctx context.Context, sourceUser, targetUser string) (*UserFriendshipResponse, error)
  • func (c *Client) UserLookupByUsername(ctx context.Context, username string) (*UserLookupByUsernameResponse, error)
• type PaginationMeta
• type Parameters
• type PartialError
• type TweetRetweetedByResponse
• type User
• type UserFriendshipResponse
• type UserLookupByUsernameResponse

Functions

func BoolValue

func BoolValue(b *bool) bool

func Float64Value

func Float64Value(f *float64) float64

func IntValue

func IntValue(i *int) int

func StringValue

func StringValue(s *string) string

func TimeValue

func TimeValue(t *time.Time) time.Time

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(apiToken string) *Client

func (*Client) Request

func (c *Client) Request(ctx context.Context, method, path string, params Parameters, resp interface{}) error

func (*Client) TweetRetweetedByUsers

func (c *Client) TweetRetweetedByUsers(ctx context.Context, tweetID string) ([]User, error)

https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/quick-start/retweets-lookup

func (*Client) UserFriendshipShow

func (c *Client) UserFriendshipShow(ctx context.Context, sourceUser, targetUser string) (*UserFriendshipResponse, error)

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show

func (*Client) UserLookupByUsername

func (c *Client) UserLookupByUsername(ctx context.Context, username string) (*UserLookupByUsernameResponse, error)

https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username

type PaginationMeta

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

type Parameters

type Parameters struct {
	Body        interface{}
	PathParams  map[string]string
	QueryParams map[string]string
}

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 TweetRetweetedByResponse

type TweetRetweetedByResponse struct {
	Data   []User         `json:"data"`
	Meta   PaginationMeta `json:"meta,omitempty"`
	Errors []PartialError `json:"errors,omitempty"`
}

type User

type User struct {
	ID       *string `json:"id"`
	Name     *string `json:"name"`
	Username *string `json:"username"`
}

type UserFriendshipResponse

type UserFriendshipResponse struct {
	Relationship struct {
		Source struct {
			ID         string `json:"id_str"`
			Username   string `json:"screen_name"`
			Following  bool   `json:"following"`
			FollowedBy bool   `json:"followed_by"`
		} `json:"source"`
		Target struct {
			ID         string `json:"id_str"`
			Username   string `json:"screen_name"`
			Following  bool   `json:"following"`
			FollowedBy bool   `json:"followed_by"`
		} `json:"target"`
	} `json:"relationship"`
}

type UserLookupByUsernameResponse

type UserLookupByUsernameResponse struct {
	Data   User           `json:"data"`
	Errors []PartialError `json:"errors"`
}