Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pkgo

package module

Go to main page

Versions in this module

v2

v2.1.1

Aug 21, 2024

v2.1.0

Feb 26, 2023

Changes in this version

+ type AutoproxySettings struct

+ LastLatchTimestamp time.Time

+ Member string

+ Mode AutoproxyMode

+ type EditAutoproxyData struct

+ Member NullableString

+ Mode *AutoproxyMode

type Session

+ UserAgent string

+ func (s *Session) EditGuildAutoproxy(guildID Snowflake, dat EditAutoproxyData) (as AutoproxySettings, err error)

+ func (s *Session) GuildAutoproxy(guildID Snowflake) (as AutoproxySettings, err error)

v2.0.2

Oct 12, 2022

Changes in this version

+ type HTTPError int

+ func (h HTTPError) Error() string

v2.0.1

Jan 14, 2022

v2.0.0

Dec 26, 2021

Changes in this version

+ const DuplicateMembersInList

+ const ErrInvalidID

+ const ErrInvalidProxyTag

+ const ErrInvalidSnowflake

+ const ErrMsgNotFound

+ const ErrNoToken

+ const ErrPrivacyInvalid

+ const GroupLimitReached

+ const GroupNotFound

+ const GroupNotFoundWithRef

+ const InvalidSwitchID

+ const MemberGuildNotFound

+ const MemberLimitReached

+ const MemberNotFound

+ const MemberNotFoundWithRef

+ const MessageNotFound

+ const MissingAutoproxyMember

+ const NotOwnGroup

+ const NotOwnGroupWithRef

+ const NotOwnMember

+ const NotOwnMemberWithRef

+ const SameSwitchMembers

+ const SameSwitchTimestamp

+ const SwitchNotFound

+ const SwitchNotFoundPublic

+ const SystemGuildNotFound

+ const SystemNotFound

+ const UnauthorizedCurrentFronters

+ const UnauthorizedFrontHistory

+ const UnauthorizedGroupList

+ const UnauthorizedGroupMemberList

+ const UnauthorizedMemberList

+ const Unimplemented

+ var BaseURL = "https://api.pluralkit.me/v"

+ var Version = "2"

+ type AutoproxyMode string

+ var AutoproxyModeFront AutoproxyMode = "front"

+ var AutoproxyModeLatch AutoproxyMode = "latch"

+ var AutoproxyModeMember AutoproxyMode = "member"

+ var AutoproxyModeOff AutoproxyMode = "off"

+ type Birthday time.Time

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

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

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

+ func (bd Birthday) Time() time.Time

+ type Color string

+ func (c Color) IsValid() bool

+ func (c Color) ToInt() int64

+ type CreateGroupData struct

+ Banner string

+ Color Color

+ Description string

+ DisplayName string

+ Icon string

+ Name string

+ Privacy *GroupPrivacy

+ type CreateMemberData struct

+ AvatarURL string

+ Banner string

+ Birthday Birthday

+ Color Color

+ Description string

+ DisplayName string

+ KeepProxy bool

+ Name string

+ Privacy *MemberPrivacy

+ Pronouns string

+ ProxyTags []ProxyTag

+ type EditGroupData struct

+ Banner NullableString

+ Color *Color

+ Description NullableString

+ DisplayName NullableString

+ Icon NullableString

+ Name NullableString

+ Privacy *GroupPrivacy

+ type EditMemberData struct

+ AvatarURL NullableString

+ Banner NullableString

+ Birthday *Birthday

+ Color *Color

+ Description NullableString

+ DisplayName NullableString

+ KeepProxy bool

+ Name NullableString

+ Privacy *MemberPrivacy

+ Pronouns NullableString

+ ProxyTags []ProxyTag

+ type EditMemberGuildData struct

+ AvatarURL NullableString

+ DisplayName NullableString

+ type EditSystemData struct

+ AvatarURL NullableString

+ Banner NullableString

+ Color NullableString

+ Description NullableString

+ Name NullableString

+ Privacy *SystemPrivacy

+ Tag NullableString

+ Timezone NullableString

+ type EditSystemGuildData struct

+ AutoproxyMember NullableString

+ AutoproxyMode *AutoproxyMode

+ ProxyingEnabled NullableBool

+ Tag NullableString

+ TagEnabled NullableBool

+ type Front struct

+ ID uuid.UUID

+ Members []Member

+ Timestamp time.Time

+ type Group struct

+ Banner string

+ Color Color

+ Description string

+ DisplayName string

+ ID string

+ Icon string

+ Members []uuid.UUID

+ Name string

+ Privacy *GroupPrivacy

+ UUID uuid.UUID

+ type GroupPrivacy struct

+ DescriptionPrivacy Privacy

+ IconPrivacy Privacy

+ ListPrivacy Privacy

+ Visibility Privacy

+ type InvalidError struct

+ func (e *InvalidError) Error() string

+ type Member struct

+ AvatarURL string

+ Banner string

+ Birthday Birthday

+ Color Color

+ Created time.Time

+ Description string

+ DisplayName string

+ ID string

+ KeepProxy bool

+ Name string

+ Privacy *MemberPrivacy

+ Pronouns string

+ ProxyTags []ProxyTag

+ UUID uuid.UUID

+ func (m Member) String() string

+ func (m Member) Validate() error

+ type MemberGuild struct

+ AvatarURL string

+ DisplayName string

+ type MemberPrivacy struct

+ AvatarPrivacy Privacy

+ BirthdayPrivacy Privacy

+ DescriptionPrivacy Privacy

+ MetadataPrivacy Privacy

+ NamePrivacy Privacy

+ PronounPrivacy Privacy

+ Visibility Privacy

+ type Message struct

+ Channel Snowflake

+ ID Snowflake

+ Member *Member

+ Original Snowflake

+ Sender Snowflake

+ System *System

+ Timestamp time.Time

+ type ModelError struct

+ ActualLength int

+ MaxLength int

+ Message string

+ type NullableBool = *bool

+ func NewNullableBool(b bool) NullableBool

+ type NullableInt = *int

+ func NewNullableInt(i int) NullableInt

+ type NullableString = *string

+ func NewNullableString(s string) NullableString

+ type PKAPIError struct

+ Code int

+ Errors map[string][]ModelError

+ Message string

+ RetryAfter *int

+ StatusCode int

+ func (e PKAPIError) Error() string

+ type Privacy string

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

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

+ type ProxyTag struct

+ Prefix string

+ Suffix string

+ func (t ProxyTag) MarshalJSON() (b []byte, err error)

+ func (t ProxyTag) String() string

+ type RequestOption func(*http.Request) error

+ func WithBody(r io.Reader) RequestOption

+ func WithHeader(header http.Header) RequestOption

+ func WithJSONBody(v interface{}) RequestOption

+ func WithURLValues(values url.Values) RequestOption

+ type Session struct

+ BaseURL string

+ Client *http.Client

+ RequestOptions []RequestOption

+ Timeout time.Duration

+ func New(token string) *Session

+ func NewWithLimiter(token string, limiter *rate.Limiter) *Session

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

+ func (s *Session) AddGroupMembers(groupID string, memberIDs []string) (err error)

+ func (s *Session) AddMemberGroups(memberID string, groupIDs []string) (err error)

+ func (s *Session) CreateGroup(data CreateGroupData) (g Group, err error)

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

+ func (s *Session) DeleteGroup(id string) (err error)

+ func (s *Session) DeleteMember(id string) (err error)

+ func (s *Session) DeleteSwitch(id uuid.UUID) (err error)

+ func (s *Session) EditGroup(id string, dat EditGroupData) (g Group, err error)

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

+ func (s *Session) EditMemberGuild(memberID string, guildID Snowflake, dat EditMemberGuildData) (mg MemberGuild, err error)

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

+ func (s *Session) EditSystemGuild(guildID Snowflake, dat EditSystemGuildData) (sg SystemGuild, err error)

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

+ func (s *Session) Group(id string) (g Group, err error)

+ func (s *Session) GroupByUUID(id uuid.UUID) (g Group, err error)

+ func (s *Session) GroupMembers(groupID string) (m []Member, err error)

+ func (s *Session) Groups(systemID string) (g []Group, err error)

+ func (s *Session) GroupsWithMembers(systemID string) (g []Group, err error)

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

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

+ func (s *Session) MemberByUUID(id uuid.UUID) (Member, error)

+ func (s *Session) MemberGroups(id string) (g []Group, err error)

+ func (s *Session) MemberGuild(memberID string, guildID Snowflake) (mg MemberGuild, err error)

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

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

+ func (s *Session) OverwriteGroupMembers(groupID string, memberIDs []string) (err error)

+ func (s *Session) OverwriteMemberGroups(memberID string, groupIDs []string) (err error)

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

+ func (s *Session) RegisterSwitchWithTimestamp(t time.Time, ids ...string) (err error)

+ func (s *Session) RemoveGroupMembers(groupID string, memberIDs []string) (err error)

+ func (s *Session) RemoveMemberGroups(memberID string, groupIDs []string) (err error)

+ func (s *Session) Request(method, endpoint string, opts ...RequestOption) (response []byte, err error)

+ func (s *Session) RequestJSON(method, endpoint string, v interface{}, opts ...RequestOption) error

+ func (s *Session) Switch(systemID string, switchID uuid.UUID) (f Front, err error)

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

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

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

+ func (s *Session) SystemByUUID(id uuid.UUID) (System, error)

+ func (s *Session) SystemGuild(guildID Snowflake) (sg SystemGuild, err error)

+ func (s *Session) SystemSettings() (settings SystemSettings, err error)

+ func (s *Session) UpdateSwitchMembers(id uuid.UUID, members []string) (f Front, err error)

+ func (s *Session) UpdateSwitchTimestamp(id uuid.UUID, t time.Time) (f Front, err error)

+ func (s *Session) UpdateSystemSettings(data UpdateSystemSettingsData) (settings SystemSettings, err error)

+ type Snowflake uint64

+ func ParseSnowflake(str string) (Snowflake, error)

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

+ func (s Snowflake) String() string

+ type Switch struct

+ ID uuid.UUID

+ Members []string

+ Timestamp time.Time

+ type System struct

+ AvatarURL string

+ Banner string

+ Color string

+ Created time.Time

+ Description string

+ ID string

+ Name string

+ Privacy *SystemPrivacy

+ Tag string

+ UUID uuid.UUID

+ type SystemGuild struct

+ AutoproxyMember string

+ AutoproxyMode AutoproxyMode

+ ProxyingEnabled bool

+ Tag string

+ TagEnabled bool

+ type SystemPrivacy struct

+ DescriptionPrivacy Privacy

+ FrontHistoryPrivacy Privacy

+ FrontPrivacy Privacy

+ GroupListPrivacy Privacy

+ MemberListPrivacy Privacy

+ type SystemSettings struct

+ GroupDefaultPrivate bool

+ GroupLimit int

+ LatchTimeout int

+ MemberDefaultPrivate bool

+ MemberLimit int

+ PingsEnabled bool

+ ShowPrivateInfo bool

+ Timezone string

+ type UpdateSystemSettingsData struct

+ GroupDefaultPrivate NullableBool

+ LatchTimeout NullableInt

+ MemberDefaultPrivate NullableBool

+ PingsEnabled NullableBool

+ ShowPrivateInfo NullableBool

+ Timezone NullableString

v2.0.0-beta.1

Nov 11, 2021

Other modules containing this package

github.com/starshine-sys/pkgo