pkgo – github.com/starshine-sys/pkgo Index | Files

package pkgo

import "github.com/starshine-sys/pkgo"

Index

Constants 

const (
	BirthdayMMDD         = "01-02"
	BirthdayDDMM         = "02-01"
	BirthdayMonthName    = "January 2"
	BirthdayMonthNameRev = "2 January"
)

Birthday format constants

Variables 

var (
	ErrNoToken          = errors.New("pkgo: no token in session, can't hit endpoints requiring authentication")
	ErrInvalidID        = errors.New("pkgo: not a 5-character ID")
	ErrInvalidSnowflake = errors.New("pkgo: not a valid Discord snowflake")
	ErrMsgNotFound      = errors.New("pkgo: message not found")
	ErrPrivacyInvalid   = errors.New("pkgo: invalid privacy setting")
)

Errors 

var ErrRateLimit = errors.New("pkgo: hit API rate limits")

ErrRateLimit is returned when the API rate limit is hit

Types

type Birthday 

type Birthday time.Time

Birthday is a member's birthday

func ParseBirthday 

func ParseBirthday(in string) (bd Birthday, err error)

ParseBirthday parses a birthday in yyyy-mm-dd or mm-dd format.

func (Birthday) MarshalJSON 

func (bd Birthday) MarshalJSON() (b []byte, err error)

MarshalJSON ...

func (Birthday) Time 

func (bd Birthday) Time() time.Time

Time returns bd as time.Time

func (*Birthday) UnmarshalJSON 

func (bd *Birthday) UnmarshalJSON(v []byte) error

UnmarshalJSON ...

type Color 

type Color string

Color holds the color for a member

func (Color) IsValid 

func (c Color) IsValid() bool

IsValid returns true if the color is valid for PK

func (Color) ToInt 

func (c Color) ToInt() int64

ToInt converts the color to an int64 value

type Config 

type Config struct {
	Token  string
	NoRate bool
}

Config is the config struct, passed to (Session).NewConfig()

type CreateMemberData 

type CreateMemberData struct {
	Name        string `json:"name,omitempty"`
	DisplayName string `json:"display_name,omitempty"`

	Description string   `json:"description,omitempty"`
	Pronouns    string   `json:"pronouns,omitempty"`
	Color       Color    `json:"color,omitempty"`
	Birthday    Birthday `json:"birthday,omitempty"`
	AvatarURL   string   `json:"avatar_url,omitempty"`

	ProxyTags []ProxyTag `json:"proxy_tags,omitempty"`
	KeepProxy bool       `json:"keep_proxy"`

	Visibility         Privacy `json:"visibility,omitempty"`
	NamePrivacy        Privacy `json:"name_privacy,omitempty"`
	DescriptionPrivacy Privacy `json:"description_privacy,omitempty"`
	AvatarPrivacy      Privacy `json:"avatar_privacy,omitempty"`
	BirthdayPrivacy    Privacy `json:"birthday_privacy,omitempty"`
	PronounPrivacy     Privacy `json:"pronoun_privacy,omitempty"`
	MetadataPrivacy    Privacy `json:"metadata_privacy,omitempty"`
}

CreateMemberData ...

type EditMemberData 

type EditMemberData struct {
	Name        string `json:"name,omitempty"`
	DisplayName string `json:"display_name,omitempty"`

	Description string   `json:"description,omitempty"`
	Pronouns    string   `json:"pronouns,omitempty"`
	Color       Color    `json:"color,omitempty"`
	Birthday    Birthday `json:"birthday,omitempty"`
	AvatarURL   string   `json:"avatar_url,omitempty"`

	ProxyTags []ProxyTag `json:"proxy_tags,omitempty"`
	KeepProxy bool       `json:"keep_proxy,omitempty"`

	Visibility         Privacy `json:"visibility,omitempty"`
	NamePrivacy        Privacy `json:"name_privacy,omitempty"`
	DescriptionPrivacy Privacy `json:"description_privacy,omitempty"`
	AvatarPrivacy      Privacy `json:"avatar_privacy,omitempty"`
	BirthdayPrivacy    Privacy `json:"birthday_privacy,omitempty"`
	PronounPrivacy     Privacy `json:"pronoun_privacy,omitempty"`
	MetadataPrivacy    Privacy `json:"metadata_privacy,omitempty"`
}

EditMemberData ...

type EditSystemData 

type EditSystemData struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Tag         string `json:"tag,omitempty"`
	AvatarURL   string `json:"avatar_url,omitempty"`
	Timezone    string `json:"tz,omitempty"`

	DescriptionPrivacy  Privacy `json:"description_privacy,omitempty"`
	MemberListPrivacy   Privacy `json:"member_list_privacy,omitempty"`
	FrontPrivacy        Privacy `json:"front_privacy,omitempty"`
	FrontHistoryPrivacy Privacy `json:"front_history_privacy,omitempty"`
}

EditSystemData ...

type Front 

type Front struct {
	Timestamp time.Time `json:"timestamp,omitempty"`
	Members   []Member  `json:"members"`
}

Front holds the info for a full switch, as queried from /s/:id/fronters

type InvalidError 

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

InvalidError is returned when the data for a PATCH or POST endpoint is invalid.

func (*InvalidError) Error 

func (e *InvalidError) Error() string

type Member 

type Member struct {
	ID      string    `json:"id"`
	Created time.Time `json:"created"`

	Name        string `json:"name,omitempty"`
	DisplayName string `json:"display_name,omitempty"`

	Description string   `json:"description,omitempty"`
	Pronouns    string   `json:"pronouns,omitempty"`
	Color       Color    `json:"color,omitempty"`
	Birthday    Birthday `json:"birthday,omitempty"`
	AvatarURL   string   `json:"avatar_url,omitempty"`

	ProxyTags []ProxyTag `json:"proxy_tags,omitempty"`
	KeepProxy bool       `json:"keep_proxy"`

	Visibility         Privacy `json:"visibility,omitempty"`
	NamePrivacy        Privacy `json:"name_privacy,omitempty"`
	DescriptionPrivacy Privacy `json:"description_privacy,omitempty"`
	AvatarPrivacy      Privacy `json:"avatar_privacy,omitempty"`
	BirthdayPrivacy    Privacy `json:"birthday_privacy,omitempty"`
	PronounPrivacy     Privacy `json:"pronoun_privacy,omitempty"`
	MetadataPrivacy    Privacy `json:"metadata_privacy,omitempty"`
}

Member holds information for a specific system member

func (Member) String 

func (m Member) String() string

String returns the member's displayed name--either DisplayName if one is set, otherwise Name

func (Member) Validate 

func (m Member) Validate() error

Validate will validate the member object. If any of the fields have invalid values, it returns an InvalidError.

type Message 

type Message struct {
	Timestamp time.Time `json:"timestamp"`

	ID       Snowflake `json:"id"`
	Original Snowflake `json:"original"`
	Sender   Snowflake `json:"sender"`
	Channel  Snowflake `json:"channel"`

	System System `json:"system"`

	Member Member `json:"member"`
}

Message is a proxied message

type Privacy 

type Privacy string

Privacy is a system or member privacy field

func (Privacy) MarshalJSON 

func (p Privacy) MarshalJSON() (b []byte, err error)

MarshalJSON ...

func (*Privacy) UnmarshalJSON 

func (p *Privacy) UnmarshalJSON(v []byte) error

UnmarshalJSON ...

type ProxyTag 

type ProxyTag struct {
	Prefix string `json:"prefix,omitempty"`
	Suffix string `json:"suffix,omitempty"`
}

ProxyTag is a single proxy tag for a member, in the format <prefix>text<suffix>

func (*ProxyTag) String 

func (p *ProxyTag) String() string

String returns a <prefix>text<suffix> formatted version of the proxy tag

type Session 

type Session struct {

	// NoRate disables client-side rate limiting
	NoRate bool
	// contains filtered or unexported fields
}

Session is the PluralKit API session, including a token

func New 

func New(token string) *Session

New returns a session with the given token, or no token if the string is empty.

func NewConfig 

func NewConfig(c *Config) *Session

NewConfig returns a session

func (*Session) Account 

func (s *Session) Account(id Snowflake) (sys *System, err error)

Account gets a system by a Discord snowflake (user ID)

func (*Session) CreateMember 

func (s *Session) CreateMember(data CreateMemberData) (m Member, err error)

CreateMember creates a member

func (*Session) EditMember 

func (s *Session) EditMember(id string, emd EditMemberData) (*Member, error)

EditMember edits a member by ID

func (*Session) EditSystem 

func (s *Session) EditSystem(psd EditSystemData) (sys *System, err error)

EditSystem edits your system with the provided data.

func (*Session) Fronters 

func (s *Session) Fronters(id string) (f Front, err error)

Fronters gets the current fronters for a system

func (*Session) Me 

func (s *Session) Me(force bool) (sys *System, err error)

Me gets the current token's system. If force is set to true, this will always fetch the system from the API.

func (*Session) Member 

func (s *Session) Member(id string) (m Member, err error)

Member gets a member by their ID

func (*Session) Members 

func (s *Session) Members(id string) ([]Member, error)

Members gets all members of a system

func (*Session) Message 

func (s *Session) Message(id Snowflake) (m *Message, err error)

Message gets a message by Discord snowflake

func (*Session) RateLimit 

func (s *Session) RateLimit()

RateLimit blocks until we can be *sure* we won't hit the rate limit. Gets a lock on s.rate, waits 500ms, and unlocks it.

func (*Session) RegisterSwitch 

func (s *Session) RegisterSwitch(ids ...string) (err error)

RegisterSwitch registers a switch with the given member IDs

func (*Session) Switches 

func (s *Session) Switches(id string) (switches []Switch, err error)

Switches gets the latest 100 switches for a system. For earlier switches, see SwitchesBefore.

func (*Session) SwitchesBefore 

func (s *Session) SwitchesBefore(id string, before time.Time) (switches []Switch, err error)

SwitchesBefore gets the 100 switches before the given timestamp. For the latest switches, see Switches.

func (*Session) System 

func (s *Session) System(id string) (sys *System, err error)

System gets a system by its 5-character system ID

type Snowflake 

type Snowflake uint64

Snowflake is a Discord snowflake

func ParseSnowflake 

func ParseSnowflake(str string) (Snowflake, error)

ParseSnowflake parses a snowflake from a string

func (Snowflake) String 

func (s Snowflake) String() string

func (*Snowflake) UnmarshalJSON 

func (s *Snowflake) UnmarshalJSON(v []byte) error

UnmarshalJSON ...

type StatusError 

type StatusError struct {
	Code   int
	Status string
}

StatusError is returned when a request returns a non-200 status code

func (*StatusError) Error 

func (e *StatusError) Error() string

type Switch 

type Switch struct {
	Timestamp time.Time `json:"timestamp,omitempty"`
	Members   []string  `json:"members"`
}

Switch holds the info for a simple switch, as queried from /s/:id/switches

type System 

type System struct {
	ID      string    `json:"id"`
	Created time.Time `json:"created"`

	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Tag         string `json:"tag,omitempty"`
	AvatarURL   string `json:"avatar_url,omitempty"`
	Timezone    string `json:"tz,omitempty"`

	DescriptionPrivacy  Privacy `json:"description_privacy,omitempty"`
	MemberListPrivacy   Privacy `json:"member_list_privacy,omitempty"`
	FrontPrivacy        Privacy `json:"front_privacy,omitempty"`
	FrontHistoryPrivacy Privacy `json:"front_history_privacy,omitempty"`
}

System holds all the data for a system

Source Files

api.go errors.go limits.go member.go member_api.go member_objects.go message.go session.go snowflake.go switches.go system.go validators.go

Version
v0.5.0
Published
Jun 13, 2021
Platform
darwin/amd64
Imports
11 packages
Last checked
now –

Tools for package owners.