reminders

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Reminders (reminders.*). Slack began retiring these methods in March 2023. Live tests show reminders.add still works, but the reminder it creates lands in To-dos, and info, list, complete and delete answer not_found or an empty list for it.

Types

Add

</>

Identifies reminders.add in the slackline.Call that add returns.

pub type Add

AddResponse

</>

A successful response from reminders.add.

pub type AddResponse {
  AddResponse(reminder: Reminder)
}

Constructors

```
AddResponse(reminder: Reminder)
```
Arguments

reminder

The new reminder.

Complete

</>

Identifies reminders.complete in the slackline.Call that complete returns.

pub type Complete

Delete

</>

Identifies reminders.delete in the slackline.Call that delete returns.

pub type Delete

Info

</>

Identifies reminders.info in the slackline.Call that info returns.

pub type Info

InfoResponse

</>

A successful response from reminders.info.

pub type InfoResponse {
  InfoResponse(reminder: option.Option(Reminder))
}

Constructors

InfoResponse(reminder: option.Option(Reminder))

Arguments

reminder: The reminder.

ListMethod

</>

Identifies reminders.list in the slackline.Call that list returns.

pub type ListMethod

ListResponse

</>

A successful response from reminders.list.

pub type ListResponse {
  ListResponse(reminders: option.Option(List(Reminder)))
}

Constructors

ListResponse(reminders: option.Option(List(Reminder)))

Arguments

reminders: Reminders created by or for the user.

Reminder

</>

A reminder. Only non-recurring reminders have time and complete_ts.

pub type Reminder {
  Reminder(
    id: String,
    creator: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    recurring: option.Option(Bool),
    time: option.Option(Int),
    complete_ts: option.Option(Int),
  )
}

Constructors

```
Reminder(
  id: String,
  creator: option.Option(String),
  user: option.Option(String),
  text: option.Option(String),
  recurring: option.Option(Bool),
  time: option.Option(Int),
  complete_ts: option.Option(Int),
)
```
Arguments

id

The reminder ID.

creator

The user who created the reminder.

user

The user the reminder is for.

text

The content of the reminder.

recurring

Whether the reminder repeats.

time

Unix timestamp of when the reminder fires.

complete_ts

Unix timestamp of when the reminder was completed, 0 if not yet.

ReminderFrequency

</>

How often a recurring reminder repeats.

pub type ReminderFrequency {
  Daily
  Weekly
  Monthly
  Yearly
  UnknownReminderFrequency(String)
}

Constructors

```
Daily
```
daily
```
Weekly
```
weekly
```
Monthly
```
monthly
```
Yearly
```
yearly
```
UnknownReminderFrequency(String)
```
A value that this version of slackline does not know.

ReminderRecurrence

</>

The repeating behavior of a reminder.

pub type ReminderRecurrence {
  ReminderRecurrence(
    frequency: ReminderFrequency,
    weekdays: option.Option(List(ReminderWeekday)),
  )
}

Constructors

ReminderRecurrence(
  frequency: ReminderFrequency,
  weekdays: option.Option(List(ReminderWeekday)),
)

Arguments

frequency: How often the reminder repeats.
weekdays: For weekly reminders, the days of the week.

ReminderWeekday

</>

A day of the week for weekly reminders.

pub type ReminderWeekday {
  Monday
  Tuesday
  Wednesday
  Thursday
  Friday
  Saturday
  Sunday
  UnknownReminderWeekday(String)
}

Constructors

```
Monday
```
monday
```
Tuesday
```
tuesday
```
Wednesday
```
wednesday
```
Thursday
```
thursday
```
Friday
```
friday
```
Saturday
```
saturday
```
Sunday
```
sunday
```
UnknownReminderWeekday(String)
```
A value that this version of slackline does not know.

Values

add

</>

pub fn add(
  text text: String,
  time time: String,
) -> slackline.Call(Add, AddResponse)

Deprecated: Slack is retiring reminders. New reminders are filed under To-dos, where reminders.info, list, complete and delete cannot find them.

reminders.add: Creates a reminder.

reminders.Add identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/reminders/add.

User token scopes: reminders:write.

Rate limit tier: t2.

Documented errors: cannot_add_bot, cannot_add_others, cannot_add_others_recurring, cannot_add_profile_only_user, cannot_add_slackbot, cannot_parse, user_not_found.

add_response_decoder

</>

pub fn add_response_decoder() -> decode.Decoder(AddResponse)

Decodes the response from reminders.add.

complete

</>

pub fn complete(
  reminder reminder: String,
) -> slackline.Call(Complete, Nil)

Deprecated: Slack is retiring reminders. New reminders are filed under To-dos, where reminders.info, list, complete and delete cannot find them.

reminders.complete: Marks a reminder as complete.

reminders.Complete identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/reminders/complete.

User token scopes: reminders:write.

Rate limit tier: t2.

Documented errors: cannot_complete_others, cannot_complete_recurring, not_found.

delete

</>

pub fn delete(
  reminder reminder: String,
) -> slackline.Call(Delete, Nil)

Deprecated: Slack is retiring reminders. New reminders are filed under To-dos, where reminders.info, list, complete and delete cannot find them.

reminders.delete: Deletes a reminder.

reminders.Delete identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/reminders/delete.

User token scopes: reminders:write.

Rate limit tier: t2.

Documented errors: not_found.

info

</>

pub fn info(
  reminder reminder: String,
) -> slackline.Call(Info, InfoResponse)

Deprecated: Slack is retiring reminders. New reminders are filed under To-dos, where reminders.info, list, complete and delete cannot find them.

reminders.info: Gets information about a reminder.

reminders.Info identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/reminders/info.

User token scopes: reminders:read.

Rate limit tier: t2.

Documented errors: not_found.

info_response_decoder

</>

pub fn info_response_decoder() -> decode.Decoder(InfoResponse)

Decodes the response from reminders.info.

list

</>

pub fn list() -> slackline.Call(ListMethod, ListResponse)

Deprecated: Slack is retiring reminders. New reminders are filed under To-dos, where reminders.info, list, complete and delete cannot find them.

reminders.list: Lists all reminders created by or for a given user.

reminders.ListMethod identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/reminders/list.

User token scopes: reminders:read.

Rate limit tier: t2.

list_response_decoder

</>

pub fn list_response_decoder() -> decode.Decoder(ListResponse)

Decodes the response from reminders.list.

reminder_decoder

</>

pub fn reminder_decoder() -> decode.Decoder(Reminder)

Decodes Reminder from json.

reminder_frequency_decoder

</>

pub fn reminder_frequency_decoder() -> decode.Decoder(
  ReminderFrequency,
)

Decodes ReminderFrequency from a json string.

reminder_frequency_from_string

</>

pub fn reminder_frequency_from_string(
  string: String,
) -> ReminderFrequency

Parses ReminderFrequency from its json string.

reminder_frequency_to_json

</>

pub fn reminder_frequency_to_json(
  it: ReminderFrequency,
) -> json.Json

Encodes ReminderFrequency as a json string.

reminder_frequency_to_string

</>

pub fn reminder_frequency_to_string(
  it: ReminderFrequency,
) -> String

The json string of ReminderFrequency.

reminder_recurrence_decoder

</>

pub fn reminder_recurrence_decoder() -> decode.Decoder(
  ReminderRecurrence,
)

Decodes ReminderRecurrence from json.

reminder_recurrence_to_json

</>

pub fn reminder_recurrence_to_json(
  it: ReminderRecurrence,
) -> json.Json

Encodes ReminderRecurrence as json.

reminder_to_json

</>

pub fn reminder_to_json(it: Reminder) -> json.Json

Encodes Reminder as json.

reminder_weekday_decoder

</>

pub fn reminder_weekday_decoder() -> decode.Decoder(
  ReminderWeekday,
)

Decodes ReminderWeekday from a json string.

reminder_weekday_from_string

</>

pub fn reminder_weekday_from_string(
  string: String,
) -> ReminderWeekday

Parses ReminderWeekday from its json string.

reminder_weekday_to_json

</>

pub fn reminder_weekday_to_json(it: ReminderWeekday) -> json.Json

Encodes ReminderWeekday as a json string.

reminder_weekday_to_string

</>

pub fn reminder_weekday_to_string(it: ReminderWeekday) -> String

The json string of ReminderWeekday.