Copyright	(c) 2025 Sam S. Almahri
License	MIT
Maintainer	[email protected]
Safe Haskell	None
Language	Haskell2010

Web.Todoist.Domain.Section

Contents

Types
Type Class
Constructors
Lenses

Description

This module provides types and operations for working with Todoist sections. Sections are used to organize tasks within a project into logical groups.

Usage Example

import Web.Todoist.Domain.Section
import Web.Todoist.Runner
import Web.Todoist.Util.Builder

main :: IO ()
main = do
    let config = newTodoistConfig "your-api-token"

    -- Create a section in a project
    let newSec = runBuilder (newSectionBuilder "To Do" "project-id-123") mempty
    section <- todoist config (addSection newSec)

    -- Get all sections in a project with builder pattern
    let params = runBuilder sectionParamBuilder (withProjectId "project-id-123" <> withLimit 50)
    sections <- todoist config (getSections params)

For more details, see: https://developer.todoist.com/rest/v2/#sections

Synopsis

data Section = Section {
- _id :: SectionId
- _name :: Name
- _project_id :: ProjectId
- _is_collapsed :: IsCollapsed
- _order :: Order
}
newtype SectionId = SectionId {
- _id :: Text
}
data SectionCreate
data SectionUpdate
data SectionParam = SectionParam {
- project_id :: Maybe ProjectId
- cursor :: Maybe Text
- limit :: Maybe Int
}
class Monad m => TodoistSectionM (m :: Type -> Type) where
- getSections :: SectionParam -> m [Section]
- getSection :: SectionId -> m Section
- addSection :: SectionCreate -> m SectionId
- updateSection :: SectionUpdate -> SectionId -> m Section
- deleteSection :: SectionId -> m ()
- getSectionsPaginated :: SectionParam -> m ([Section], Maybe Text)
newSectionBuilder :: Text -> Text -> Initial SectionCreate
updateSectionBuilder :: Initial SectionUpdate
sectionParamBuilder :: Initial SectionParam
sectionId :: Getter Section SectionId
sectionName :: Getter Section Name
sectionProjectId :: Getter Section ProjectId
sectionIsCollapsed :: Getter Section IsCollapsed
sectionOrder :: Getter Section Order

Types

data Section Source #

Simplified domain representation of a Section (5 essential fields) Note: API returns 11 fields, but we only expose the essential ones

Constructors

Section
Fields _id :: SectionId _name :: Name _project_id :: ProjectId _is_collapsed :: IsCollapsed _order :: Order

Instances

Instances details

Generic Section Source #

Instance details

Defined in Web.Todoist.Domain.Section

Associated Types

type Rep Section

Instance details

Defined in Web.Todoist.Domain.Section

type Rep Section = D1 ('MetaData "Section" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'False) (C1 ('MetaCons "Section" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SectionId) :*: S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)) :*: (S1 ('MetaSel ('Just "_project_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectId) :*: (S1 ('MetaSel ('Just "_is_collapsed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IsCollapsed) :*: S1 ('MetaSel ('Just "_order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Order)))))

Methods

from :: Section -> Rep Section x #

to :: Rep Section x -> Section #

Show Section Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

showsPrec :: Int -> Section -> ShowS #

show :: Section -> String #

showList :: [Section] -> ShowS #

type Rep Section Source #

Instance details

Defined in Web.Todoist.Domain.Section

type Rep Section = D1 ('MetaData "Section" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'False) (C1 ('MetaCons "Section" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SectionId) :*: S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)) :*: (S1 ('MetaSel ('Just "_project_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectId) :*: (S1 ('MetaSel ('Just "_is_collapsed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IsCollapsed) :*: S1 ('MetaSel ('Just "_order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Order)))))

newtype SectionId Source #

Unique identifier for a Section

Constructors

SectionId
Fields _id :: Text

Instances

Instances details

FromJSON SectionId Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

parseJSON :: Value -> Parser SectionId #

parseJSONList :: Value -> Parser [SectionId] #

omittedField :: Maybe SectionId #

ToJSON SectionId Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

toJSON :: SectionId -> Value #

toEncoding :: SectionId -> Encoding #

toJSONList :: [SectionId] -> Value #

toEncodingList :: [SectionId] -> Encoding #

omitField :: SectionId -> Bool #

Generic SectionId Source #

Instance details

Defined in Web.Todoist.Domain.Section

Associated Types

type Rep SectionId
Instance details Defined in Web.Todoist.Domain.Section type Rep SectionId = D1 ('MetaData "SectionId" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'True) (C1 ('MetaCons "SectionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: SectionId -> Rep SectionId x #

to :: Rep SectionId x -> SectionId #

Show SectionId Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

showsPrec :: Int -> SectionId -> ShowS #

show :: SectionId -> String #

showList :: [SectionId] -> ShowS #

Eq SectionId Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

(==) :: SectionId -> SectionId -> Bool #

(/=) :: SectionId -> SectionId -> Bool #

type Rep SectionId Source #

Instance details

Defined in Web.Todoist.Domain.Section

type Rep SectionId = D1 ('MetaData "SectionId" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'True) (C1 ('MetaCons "SectionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data SectionCreate Source #

Request body for creating a new Section

Instances

Instances details

ToJSON SectionCreate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

toJSON :: SectionCreate -> Value #

toEncoding :: SectionCreate -> Encoding #

toJSONList :: [SectionCreate] -> Value #

toEncodingList :: [SectionCreate] -> Encoding #

omitField :: SectionCreate -> Bool #

Generic SectionCreate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Associated Types

type Rep SectionCreate

Instance details

Defined in Web.Todoist.Domain.Section

type Rep SectionCreate = D1 ('MetaData "SectionCreate" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'False) (C1 ('MetaCons "SectionCreate" 'PrefixI 'True) (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name) :*: (S1 ('MetaSel ('Just "_project_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectId) :*: S1 ('MetaSel ('Just "_order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Order)))))

Methods

from :: SectionCreate -> Rep SectionCreate x #

to :: Rep SectionCreate x -> SectionCreate #

Show SectionCreate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

showsPrec :: Int -> SectionCreate -> ShowS #

show :: SectionCreate -> String #

showList :: [SectionCreate] -> ShowS #

HasName SectionCreate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

hasName :: Text -> SectionCreate -> SectionCreate Source #

HasOrder SectionCreate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

hasOrder :: Int -> SectionCreate -> SectionCreate Source #

type Rep SectionCreate Source #

Instance details

Defined in Web.Todoist.Domain.Section

type Rep SectionCreate = D1 ('MetaData "SectionCreate" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'False) (C1 ('MetaCons "SectionCreate" 'PrefixI 'True) (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name) :*: (S1 ('MetaSel ('Just "_project_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectId) :*: S1 ('MetaSel ('Just "_order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Order)))))

data SectionUpdate Source #

Request body for updating a Section (partial updates) Uses omitNothingFields to only send fields that are set

Instances

Instances details

ToJSON SectionUpdate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

toJSON :: SectionUpdate -> Value #

toEncoding :: SectionUpdate -> Encoding #

toJSONList :: [SectionUpdate] -> Value #

toEncodingList :: [SectionUpdate] -> Encoding #

omitField :: SectionUpdate -> Bool #

Generic SectionUpdate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Associated Types

type Rep SectionUpdate
Instance details Defined in Web.Todoist.Domain.Section type Rep SectionUpdate = D1 ('MetaData "SectionUpdate" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'True) (C1 ('MetaCons "SectionUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Name))))

Methods

from :: SectionUpdate -> Rep SectionUpdate x #

to :: Rep SectionUpdate x -> SectionUpdate #

Show SectionUpdate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

showsPrec :: Int -> SectionUpdate -> ShowS #

show :: SectionUpdate -> String #

showList :: [SectionUpdate] -> ShowS #

HasName SectionUpdate Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

hasName :: Text -> SectionUpdate -> SectionUpdate Source #

type Rep SectionUpdate Source #

Instance details

Defined in Web.Todoist.Domain.Section

type Rep SectionUpdate = D1 ('MetaData "SectionUpdate" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'True) (C1 ('MetaCons "SectionUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Name))))

data SectionParam Source #

Query parameters for filtering and paginating sections

Constructors

SectionParam
Fields project_id :: Maybe ProjectId cursor :: Maybe Text limit :: Maybe Int

Instances

Instances details

Generic SectionParam Source #

Instance details

Defined in Web.Todoist.Domain.Section

Associated Types

type Rep SectionParam

Instance details

Defined in Web.Todoist.Domain.Section

type Rep SectionParam = D1 ('MetaData "SectionParam" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'False) (C1 ('MetaCons "SectionParam" 'PrefixI 'True) (S1 ('MetaSel ('Just "project_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectId)) :*: (S1 ('MetaSel ('Just "cursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

Methods

from :: SectionParam -> Rep SectionParam x #

to :: Rep SectionParam x -> SectionParam #

Show SectionParam Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

showsPrec :: Int -> SectionParam -> ShowS #

show :: SectionParam -> String #

showList :: [SectionParam] -> ShowS #

HasCursor SectionParam Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

hasCursor :: Text -> SectionParam -> SectionParam Source #

HasLimit SectionParam Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

hasLimit :: Int -> SectionParam -> SectionParam Source #

HasProjectId SectionParam Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

hasProjectId :: Text -> SectionParam -> SectionParam Source #

QueryParam SectionParam Source #

Instance details

Defined in Web.Todoist.Domain.Section

Methods

toQueryParam :: SectionParam -> Params Source #

type Rep SectionParam Source #

Instance details

Defined in Web.Todoist.Domain.Section

type Rep SectionParam = D1 ('MetaData "SectionParam" "Web.Todoist.Domain.Section" "todoist-sdk-0.1.2.1-DGBtxdXKO1e8ZQYcxjFTC8" 'False) (C1 ('MetaCons "SectionParam" 'PrefixI 'True) (S1 ('MetaSel ('Just "project_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectId)) :*: (S1 ('MetaSel ('Just "cursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

Type Class

class Monad m => TodoistSectionM (m :: Type -> Type) where Source #

Type class defining Section operations

Methods

getSections :: SectionParam -> m [Section] Source #

Get all sections (automatically fetches all pages)

getSection :: SectionId -> m Section Source #

Get a single section by ID

addSection :: SectionCreate -> m SectionId Source #

Create a new section

updateSection :: SectionUpdate -> SectionId -> m Section Source #

Update a section

deleteSection :: SectionId -> m () Source #

Delete a section (and all its tasks)

getSectionsPaginated :: SectionParam -> m ([Section], Maybe Text) Source #

Get sections with manual pagination control Returns a tuple of (results, next_cursor) for the requested page

Instances

Instances details

TodoistSectionM TodoistIO Source #
Instance details Defined in Web.Todoist.Runner.IO.Interpreters Methods getSections :: SectionParam -> TodoistIO [Section] Source # getSection :: SectionId -> TodoistIO Section Source # addSection :: SectionCreate -> TodoistIO SectionId Source # updateSection :: SectionUpdate -> SectionId -> TodoistIO Section Source # deleteSection :: SectionId -> TodoistIO () Source # getSectionsPaginated :: SectionParam -> TodoistIO ([Section], Maybe Text) Source #
TodoistSectionM Trace Source #
Instance details Defined in Web.Todoist.Runner.Trace Methods getSections :: SectionParam -> Trace [Section] Source # getSection :: SectionId -> Trace Section Source # addSection :: SectionCreate -> Trace SectionId Source # updateSection :: SectionUpdate -> SectionId -> Trace Section Source # deleteSection :: SectionId -> Trace () Source # getSectionsPaginated :: SectionParam -> Trace ([Section], Maybe Text) Source #

Constructors

newSectionBuilder :: Text -> Text -> Initial SectionCreate Source #

Smart constructor for creating a new section

updateSectionBuilder :: Initial SectionUpdate Source #

Empty section update for builder pattern

sectionParamBuilder :: Initial SectionParam Source #

Create new SectionParam for use with builder pattern

Lenses

sectionId :: Getter Section SectionId Source #

Lenses for Section

sectionName :: Getter Section Name Source #

sectionProjectId :: Getter Section ProjectId Source #

sectionIsCollapsed :: Getter Section IsCollapsed Source #

sectionOrder :: Getter Section Order Source #