feat(guild): implement onboarding (#1401)
Add guild onboarding endpoints and related structs. --------- Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>
This commit is contained in:
Earlopain
GitHub
parent
b3638db82a
commit
30b2cf22b4
3 changed files with 138 additions and 0 deletions
|
|
@ -103,6 +103,7 @@ var (
|
|||
EndpointGuildScheduledEvents = func(gID string) string { return EndpointGuilds + gID + "/scheduled-events" }
|
||||
EndpointGuildScheduledEvent = func(gID, eID string) string { return EndpointGuilds + gID + "/scheduled-events/" + eID }
|
||||
EndpointGuildScheduledEventUsers = func(gID, eID string) string { return EndpointGuildScheduledEvent(gID, eID) + "/users" }
|
||||
EndpointGuildOnboarding = func(gID string) string { return EndpointGuilds + gID + "/onboarding" }
|
||||
EndpointGuildTemplate = func(tID string) string { return EndpointGuilds + "templates/" + tID }
|
||||
EndpointGuildTemplates = func(gID string) string { return EndpointGuilds + gID + "/templates" }
|
||||
EndpointGuildTemplateSync = func(gID, tID string) string { return EndpointGuilds + gID + "/templates/" + tID }
|
||||
|
|
|
|||
31
restapi.go
31
restapi.go
|
|
@ -3281,6 +3281,37 @@ func (s *Session) GuildScheduledEventUsers(guildID, eventID string, limit int, w
|
|||
return
|
||||
}
|
||||
|
||||
// GuildOnboarding returns onboarding configuration of a guild.
|
||||
// guildID : The ID of the guild
|
||||
func (s *Session) GuildOnboarding(guildID string, options ...RequestOption) (onboarding *GuildOnboarding, err error) {
|
||||
endpoint := EndpointGuildOnboarding(guildID)
|
||||
|
||||
var body []byte
|
||||
body, err = s.RequestWithBucketID("GET", endpoint, nil, endpoint, options...)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = unmarshal(body, &onboarding)
|
||||
return
|
||||
}
|
||||
|
||||
// GuildOnboardingEdit edits onboarding configuration of a guild.
|
||||
// guildID : The ID of the guild
|
||||
// o : New GuildOnboarding data
|
||||
func (s *Session) GuildOnboardingEdit(guildID string, o *GuildOnboarding, options ...RequestOption) (onboarding *GuildOnboarding, err error) {
|
||||
endpoint := EndpointGuildOnboarding(guildID)
|
||||
|
||||
var body []byte
|
||||
body, err = s.RequestWithBucketID("PUT", endpoint, o, endpoint, options...)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = unmarshal(body, &onboarding)
|
||||
return
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Functions specific to auto moderation
|
||||
// ----------------------------------------------------------------------
|
||||
|
|
|
|||
106
structs.go
106
structs.go
|
|
@ -1074,6 +1074,109 @@ type GuildScheduledEventUser struct {
|
|||
Member *Member `json:"member"`
|
||||
}
|
||||
|
||||
// GuildOnboardingMode defines the criteria used to satisfy constraints that are required for enabling onboarding.
|
||||
// https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
|
||||
type GuildOnboardingMode int
|
||||
|
||||
// Block containing known GuildOnboardingMode values.
|
||||
const (
|
||||
// GuildOnboardingModeDefault counts default channels towards constraints.
|
||||
GuildOnboardingModeDefault GuildOnboardingMode = 0
|
||||
// GuildOnboardingModeAdvanced counts default channels and questions towards constraints.
|
||||
GuildOnboardingModeAdvanced GuildOnboardingMode = 1
|
||||
)
|
||||
|
||||
// GuildOnboarding represents the onboarding flow for a guild.
|
||||
// https://discord.com/developers/docs/resources/guild#guild-onboarding-object
|
||||
type GuildOnboarding struct {
|
||||
// ID of the guild this onboarding flow is part of.
|
||||
GuildID string `json:"guild_id,omitempty"`
|
||||
|
||||
// Prompts shown during onboarding and in the customize community (Channels & Roles) tab.
|
||||
Prompts *[]GuildOnboardingPrompt `json:"prompts,omitempty"`
|
||||
|
||||
// Channel IDs that members get opted into automatically.
|
||||
DefaultChannelIDs []string `json:"default_channel_ids,omitempty"`
|
||||
|
||||
// Whether onboarding is enabled in the guild.
|
||||
Enabled *bool `json:"enabled,omitempty"`
|
||||
|
||||
// Mode of onboarding.
|
||||
Mode *GuildOnboardingMode `json:"mode,omitempty"`
|
||||
}
|
||||
|
||||
// GuildOnboardingPromptType is the type of an onboarding prompt.
|
||||
// https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
|
||||
type GuildOnboardingPromptType int
|
||||
|
||||
// Block containing known GuildOnboardingPromptType values.
|
||||
const (
|
||||
GuildOnboardingPromptTypeMultipleChoice GuildOnboardingPromptType = 0
|
||||
GuildOnboardingPromptTypeDropdown GuildOnboardingPromptType = 1
|
||||
)
|
||||
|
||||
// GuildOnboardingPrompt is a prompt shown during onboarding and in the customize community (Channels & Roles) tab.
|
||||
// https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
|
||||
type GuildOnboardingPrompt struct {
|
||||
// ID of the prompt.
|
||||
// NOTE: always requires to be a valid snowflake (e.g. "0"), see
|
||||
// https://github.com/discord/discord-api-docs/issues/6320 for more information.
|
||||
ID string `json:"id,omitempty"`
|
||||
|
||||
// Type of the prompt.
|
||||
Type GuildOnboardingPromptType `json:"type"`
|
||||
|
||||
// Options available within the prompt.
|
||||
Options []GuildOnboardingPromptOption `json:"options"`
|
||||
|
||||
// Title of the prompt.
|
||||
Title string `json:"title"`
|
||||
|
||||
// Indicates whether users are limited to selecting one option for the prompt.
|
||||
SingleSelect bool `json:"single_select"`
|
||||
|
||||
// Indicates whether the prompt is required before a user completes the onboarding flow.
|
||||
Required bool `json:"required"`
|
||||
|
||||
// Indicates whether the prompt is present in the onboarding flow.
|
||||
// If false, the prompt will only appear in the customize community (Channels & Roles) tab.
|
||||
InOnboarding bool `json:"in_onboarding"`
|
||||
}
|
||||
|
||||
// GuildOnboardingPromptOption is an option available within an onboarding prompt.
|
||||
// https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure
|
||||
type GuildOnboardingPromptOption struct {
|
||||
// ID of the prompt option.
|
||||
ID string `json:"id,omitempty"`
|
||||
|
||||
// IDs for channels a member is added to when the option is selected.
|
||||
ChannelIDs []string `json:"channel_ids"`
|
||||
|
||||
// IDs for roles assigned to a member when the option is selected.
|
||||
RoleIDs []string `json:"role_ids"`
|
||||
|
||||
// Emoji of the option.
|
||||
// NOTE: when creating or updating a prompt option
|
||||
// EmojiID, EmojiName and EmojiAnimated should be used instead.
|
||||
Emoji *Emoji `json:"emoji,omitempty"`
|
||||
|
||||
// Title of the option.
|
||||
Title string `json:"title"`
|
||||
|
||||
// Description of the option.
|
||||
Description string `json:"description"`
|
||||
|
||||
// ID of the option's emoji.
|
||||
// NOTE: only used when creating or updating a prompt option.
|
||||
EmojiID string `json:"emoji_id,omitempty"`
|
||||
// Name of the option's emoji.
|
||||
// NOTE: only used when creating or updating a prompt option.
|
||||
EmojiName string `json:"emoji_name,omitempty"`
|
||||
// Whether the option's emoji is animated.
|
||||
// NOTE: only used when creating or updating a prompt option.
|
||||
EmojiAnimated *bool `json:"emoji_animated,omitempty"`
|
||||
}
|
||||
|
||||
// A GuildTemplate represents a replicable template for guild creation
|
||||
type GuildTemplate struct {
|
||||
// The unique code for the guild template
|
||||
|
|
@ -2371,6 +2474,9 @@ const (
|
|||
|
||||
ErrCodeCannotUpdateAFinishedEvent = 180000
|
||||
ErrCodeFailedToCreateStageNeededForStageEvent = 180002
|
||||
|
||||
ErrCodeCannotEnableOnboardingRequirementsAreNotMet = 350000
|
||||
ErrCodeCannotUpdateOnboardingWhileBelowRequirements = 350001
|
||||
)
|
||||
|
||||
// Intent is the type of a Gateway Intent
|
||||
|
|
|
|||
Loading…
Reference in a new issue