onboarding

Types

Mode

pub type Mode {
  Default
  Advanced
}

Constructors

```
Default
```
```
Advanced
```

Modify

</>

pub type Modify {
  Modify(
    prompts: modification.Modification(List(Prompt)),
    default_channel_ids: modification.Modification(List(String)),
    is_enabled: option.Option(Bool),
    mode: modification.Modification(Mode),
  )
}

Constructors

Modify(
  prompts: modification.Modification(List(Prompt)),
  default_channel_ids: modification.Modification(List(String)),
  is_enabled: option.Option(Bool),
  mode: modification.Modification(Mode),
)

Onboarding

</>

pub type Onboarding {
  Onboarding(
    guild_id: String,
    prompts: List(Prompt),
    default_channel_ids: List(String),
    is_enabled: Bool,
    mode: Mode,
  )
}

Constructors

Onboarding(
  guild_id: String,
  prompts: List(Prompt),
  default_channel_ids: List(String),
  is_enabled: Bool,
  mode: Mode,
)

Prompt

</>

pub type Prompt {
  Prompt(
    id: String,
    type_: PromptType,
    options: List(PromptOption),
    title: String,
    is_single_select: Bool,
    is_required: Bool,
    is_in_onboarding: Bool,
  )
}

Constructors

Prompt(
  id: String,
  type_: PromptType,
  options: List(PromptOption),
  title: String,
  is_single_select: Bool,
  is_required: Bool,
  is_in_onboarding: Bool,
)

PromptOption

</>

pub type PromptOption {
  PromptOption(
    id: String,
    channel_ids: List(String),
    role_ids: List(String),
    emoji: option.Option(emoji.Emoji),
    emoji_id: option.Option(String),
    emoji_name: option.Option(String),
    is_emoji_animated: option.Option(Bool),
    title: String,
    description: option.Option(String),
  )
}

Constructors

PromptOption(
  id: String,
  channel_ids: List(String),
  role_ids: List(String),
  emoji: option.Option(emoji.Emoji),
  emoji_id: option.Option(String),
  emoji_name: option.Option(String),
  is_emoji_animated: option.Option(Bool),
  title: String,
  description: option.Option(String),
)

PromptType

</>

pub type PromptType {
  MultipleChoice
  Dropdown
}

Constructors

```
MultipleChoice
```
```
Dropdown
```

Values

get

</>

pub fn get(
  client: grom.Client,
  for guild_id: String,
) -> Result(Onboarding, grom.Error)

modify

</>

pub fn modify(
  client: grom.Client,
  in guild_id: String,
  using modify: Modify,
  because reason: option.Option(String),
) -> Result(Onboarding, grom.Error)

new_modify

</>

pub fn new_modify() -> Modify