Network.CiscoSpark

This module provides types and functions for accessing Cisco Spark REST API.

The module is designed to improve type safety over the API. Each entity is separately typed. JSON messages contained in REST responses are decoded into appropriate type of Haskell record. JSON messages sent in REST requests are encoded only from correct type of record.

Some Spark REST API return list of objects. Those APIs require HTTP Link Header based pagination. Haskell functions for those APIs automatically request subsequent pages as needed. Also those functions transform chunky response into seamless stream of elements.

Examples

    -- Sending a message to a room.
    let auth        = Authorization "your authorization token"
        roomId      = RoomId "Room ID your message to be sent"
        messageText = MessageText "your message"
        message     = CreateMessage (Just roomId) Nothing Nothing (Just messageText) Nothing Nothing
    createEntity auth def createMessage >>= print . getResponseBody

    -- Obtaining detail of a user.
    let personId    = PersonId "your person ID"
    getDetail auth def personId >>= print . getResponseBody

    -- Obtaining membership of a room as stream of object representing each membership relation.
    let filter = MembershipFilter yourRoomId Nothing Nothing
    runConduit $ streamEntityWithFilter auth def filter .| takeC 200 .| mapM_C print

    -- Create a room.
    let createRoom  = CreateRoom "Title of the new room" Nothing
    createEntity auth def createRoom >>= print . getResponseBody

    -- Delete a room.
    deleteRoom auth def roomId >>= print . getResponseBody

Support for Lens

This package provides many of records representing objects communicated via Cisco Spark REST API. Those records are designed to allow create lenses by Control.Lens.TH.makeFields.

Following example creates overloaded accessors for Person, Room and Team.

makeFields ''Person
makeFields ''Room
makeFields ''Team

You can access personId, roomId and teamId via overloaded accessor function id like this.

    let yourPersonId = yourPerson ^. id
        yourRoomId = yourRoom ^. id
        yourTeamId = yourTeam ^. id

This package does not provide pre-generated lenses for you because not everyone need it but you can make it by yourself so easily as described.

Types

Common Types

newtype Authorization

Authorization string against Spark API to be contained in HTTP Authorization header of every request.

Constructors

Authorization ByteString

Instances

Eq Authorization

Methods

(==) :: Authorization -> Authorization -> Bool

(/=) :: Authorization -> Authorization -> Bool

Show Authorization

Methods

showsPrec :: Int -> Authorization -> ShowS

show :: Authorization -> String

showList :: [Authorization] -> ShowS

data CiscoSparkRequest

Wrapping Request in order to provide easy default value specifically for Cisco Spark public API.

Constructors

CiscoSparkRequest

Fields

• ciscoSparkRequestRequest :: Request

  Holds pre-set Request for REST API.

• ciscoSparkRequestScheme :: String

  Should be "https:" in production.

• ciscoSparkRequestAuthority :: URIAuth

  Authority part of request URI.

Instances

Show CiscoSparkRequest

Methods

showsPrec :: Int -> CiscoSparkRequest -> ShowS

show :: CiscoSparkRequest -> String

showList :: [CiscoSparkRequest] -> ShowS

Default CiscoSparkRequest

Default parameters for HTTP request to Cisco Spark REST API.

Methods

def :: CiscoSparkRequest

newtype Timestamp

Type representing timestamp. For now, it is just copied from API response JSON.

Constructors

Timestamp Text

Instances

Eq Timestamp

Methods

(==) :: Timestamp -> Timestamp -> Bool

(/=) :: Timestamp -> Timestamp -> Bool

Show Timestamp

Methods

showsPrec :: Int -> Timestamp -> ShowS

show :: Timestamp -> String

showList :: [Timestamp] -> ShowS

Generic Timestamp

Associated Types

type Rep Timestamp :: * -> *

Methods

from :: Timestamp -> Rep Timestamp x

to :: Rep Timestamp x -> Timestamp

ToJSON Timestamp

Methods

toJSON :: Timestamp -> Value

toEncoding :: Timestamp -> Encoding

toJSONList :: [Timestamp] -> Value

toEncodingList :: [Timestamp] -> Encoding

FromJSON Timestamp

Methods

parseJSON :: Value -> Parser Timestamp

parseJSONList :: Value -> Parser [Timestamp]

type Rep Timestamp

type Rep Timestamp = D1 * (MetaData "Timestamp" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "Timestamp" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype ErrorCode

Error code for element level error potentially contained in List API responses.

Constructors

ErrorCode Text

Instances

Eq ErrorCode

Methods

(==) :: ErrorCode -> ErrorCode -> Bool

(/=) :: ErrorCode -> ErrorCode -> Bool

Show ErrorCode

Methods

showsPrec :: Int -> ErrorCode -> ShowS

show :: ErrorCode -> String

showList :: [ErrorCode] -> ShowS

Generic ErrorCode

Associated Types

type Rep ErrorCode :: * -> *

Methods

from :: ErrorCode -> Rep ErrorCode x

to :: Rep ErrorCode x -> ErrorCode

ToJSON ErrorCode

Methods

toJSON :: ErrorCode -> Value

toEncoding :: ErrorCode -> Encoding

toJSONList :: [ErrorCode] -> Value

toEncodingList :: [ErrorCode] -> Encoding

FromJSON ErrorCode

Methods

parseJSON :: Value -> Parser ErrorCode

parseJSONList :: Value -> Parser [ErrorCode]

type Rep ErrorCode

type Rep ErrorCode = D1 * (MetaData "ErrorCode" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "ErrorCode" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

data ErrorTitle

ErrorTitle represent concrete error code and reason. It appears in Errors.

Constructors

ErrorTitle

Fields

• errorTitleCode :: ErrorCode

  Error code of element level error in List API response.

• errorTitleReason :: Text

  Reason explanation of the error.

Instances

Eq ErrorTitle

Methods

(==) :: ErrorTitle -> ErrorTitle -> Bool

(/=) :: ErrorTitle -> ErrorTitle -> Bool

Show ErrorTitle

Methods

showsPrec :: Int -> ErrorTitle -> ShowS

show :: ErrorTitle -> String

showList :: [ErrorTitle] -> ShowS

ToJSON ErrorTitle

Methods

toJSON :: ErrorTitle -> Value

toEncoding :: ErrorTitle -> Encoding

toJSONList :: [ErrorTitle] -> Value

toEncodingList :: [ErrorTitle] -> Encoding

FromJSON ErrorTitle

ErrorTitle derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser ErrorTitle

parseJSONList :: Value -> Parser [ErrorTitle]

newtype Errors

Errors is used for element level error in List API. When list API failed to retrieve an element, it returns this object for the element and response API status as successful instead of failing entire API request.

Refer to API Document for more detail.

Constructors

Errors

Fields

• errorsTitle :: ErrorTitle

Instances

Eq Errors

Methods

(==) :: Errors -> Errors -> Bool

(/=) :: Errors -> Errors -> Bool

Show Errors

Methods

showsPrec :: Int -> Errors -> ShowS

show :: Errors -> String

showList :: [Errors] -> ShowS

ToJSON Errors

Methods

toJSON :: Errors -> Value

toEncoding :: Errors -> Encoding

toJSONList :: [Errors] -> Value

toEncodingList :: [Errors] -> Encoding

FromJSON Errors

Errors derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Errors

parseJSONList :: Value -> Parser [Errors]

People related types

data Person

Person is detail description of Cisco Spark user or bot. Person is decoded from response JSON of Get Person Details REST call. It is also element type of response of List People call.

Constructors

Person

Fields

• personId :: PersonId

  Identifier of the Person.

• personErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• personEmails :: Maybe [Email]

  List of email addresses which the Person has.

• personDisplayName :: Maybe DisplayName

  Display name of the Person.

• personNickName :: Maybe NickName

  Nickname of the Person.

• personFirstName :: Maybe FirstName

  First name of the Person.

• personLastName :: Maybe LastName

  Last name of the Person.

• personAvatar :: Maybe AvatarUrl

  URL pointing a image used for Avatar of the Person.

• personOrgId :: Maybe OrganizationId

  Organization which the Person belongs to.

• personRoles :: Maybe [RoleId]

  List of roles assigned to the Person.

• personLicenses :: Maybe [LicenseId]

  List of licenses effective on the Person.

• personCreated :: Maybe Timestamp

  Timestamp when the Person was created.

• personTimezone :: Maybe Timezone

  Timezone of the Person.

• personLastActivity :: Maybe Timestamp

  Timestamp of the latest activity of the Person.

• personStatus :: Maybe PersonStatus

  Current status of the Person

• personInvitePending :: Maybe Bool

  True if invitation for the Person is pending.

• personLoginEnabled :: Maybe Bool

  True if login of the Person is enabled.

• personType :: Maybe PersonType

  Indicating if the Person is real human or bot.

Instances

Eq Person

Methods

(==) :: Person -> Person -> Bool

(/=) :: Person -> Person -> Bool

Show Person

Methods

showsPrec :: Int -> Person -> ShowS

show :: Person -> String

showList :: [Person] -> ShowS

ToJSON Person

Methods

toJSON :: Person -> Value

toEncoding :: Person -> Encoding

toJSONList :: [Person] -> Value

toEncodingList :: [Person] -> Encoding

FromJSON Person

Person derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Person

parseJSONList :: Value -> Parser [Person]

SparkListItem Person

PersonList wraps Person.

Associated Types

type ToList Person :: *

Methods

unwrap :: ToList Person -> [Person]

type ToList Person

type ToList Person = PersonList

newtype PersonId

Identifying Person describing detail of Cisco Spark user or bot.

Constructors

PersonId Text

Instances

Eq PersonId

Methods

(==) :: PersonId -> PersonId -> Bool

(/=) :: PersonId -> PersonId -> Bool

Show PersonId

Methods

showsPrec :: Int -> PersonId -> ShowS

show :: PersonId -> String

showList :: [PersonId] -> ShowS

Generic PersonId

Associated Types

type Rep PersonId :: * -> *

Methods

from :: PersonId -> Rep PersonId x

to :: Rep PersonId x -> PersonId

ToJSON PersonId

Methods

toJSON :: PersonId -> Value

toEncoding :: PersonId -> Encoding

toJSONList :: [PersonId] -> Value

toEncodingList :: [PersonId] -> Encoding

FromJSON PersonId

Methods

parseJSON :: Value -> Parser PersonId

parseJSONList :: Value -> Parser [PersonId]

SparkDetail PersonId

User can get detail of a person.

Methods

toIdStr :: PersonId -> Text

SparkResponse PersonId

Get detail for a person API uses "PersonId' and responses Person.

Associated Types

type ToResponse PersonId :: *

SparkApiPath PersonId

Get detail for a person API uses PersonId and path "people".

Methods

apiPath :: PersonId -> ByteString

type Rep PersonId

type Rep PersonId = D1 * (MetaData "PersonId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "PersonId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse PersonId

type ToResponse PersonId = Person

newtype Email

Email address of user.

Constructors

Email Text

Instances

Eq Email

Methods

(==) :: Email -> Email -> Bool

(/=) :: Email -> Email -> Bool

Show Email

Methods

showsPrec :: Int -> Email -> ShowS

show :: Email -> String

showList :: [Email] -> ShowS

Generic Email

Associated Types

type Rep Email :: * -> *

Methods

from :: Email -> Rep Email x

to :: Rep Email x -> Email

ToJSON Email

Methods

toJSON :: Email -> Value

toEncoding :: Email -> Encoding

toJSONList :: [Email] -> Value

toEncodingList :: [Email] -> Encoding

FromJSON Email

Methods

parseJSON :: Value -> Parser Email

parseJSONList :: Value -> Parser [Email]

type Rep Email

type Rep Email = D1 * (MetaData "Email" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "Email" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype DisplayName

Display name of user.

Constructors

DisplayName Text

Instances

Eq DisplayName

Methods

(==) :: DisplayName -> DisplayName -> Bool

(/=) :: DisplayName -> DisplayName -> Bool

Show DisplayName

Methods

showsPrec :: Int -> DisplayName -> ShowS

show :: DisplayName -> String

showList :: [DisplayName] -> ShowS

Generic DisplayName

Associated Types

type Rep DisplayName :: * -> *

Methods

from :: DisplayName -> Rep DisplayName x

to :: Rep DisplayName x -> DisplayName

ToJSON DisplayName

Methods

toJSON :: DisplayName -> Value

toEncoding :: DisplayName -> Encoding

toJSONList :: [DisplayName] -> Value

toEncodingList :: [DisplayName] -> Encoding

FromJSON DisplayName

Methods

parseJSON :: Value -> Parser DisplayName

parseJSONList :: Value -> Parser [DisplayName]

type Rep DisplayName

type Rep DisplayName = D1 * (MetaData "DisplayName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "DisplayName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype NickName

Nickname of user.

Constructors

NickName Text

Instances

Eq NickName

Methods

(==) :: NickName -> NickName -> Bool

(/=) :: NickName -> NickName -> Bool

Show NickName

Methods

showsPrec :: Int -> NickName -> ShowS

show :: NickName -> String

showList :: [NickName] -> ShowS

Generic NickName

Associated Types

type Rep NickName :: * -> *

Methods

from :: NickName -> Rep NickName x

to :: Rep NickName x -> NickName

ToJSON NickName

Methods

toJSON :: NickName -> Value

toEncoding :: NickName -> Encoding

toJSONList :: [NickName] -> Value

toEncodingList :: [NickName] -> Encoding

FromJSON NickName

Methods

parseJSON :: Value -> Parser NickName

parseJSONList :: Value -> Parser [NickName]

type Rep NickName

type Rep NickName = D1 * (MetaData "NickName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "NickName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype FirstName

First name of user.

Constructors

FirstName Text

Instances

Eq FirstName

Methods

(==) :: FirstName -> FirstName -> Bool

(/=) :: FirstName -> FirstName -> Bool

Show FirstName

Methods

showsPrec :: Int -> FirstName -> ShowS

show :: FirstName -> String

showList :: [FirstName] -> ShowS

Generic FirstName

Associated Types

type Rep FirstName :: * -> *

Methods

from :: FirstName -> Rep FirstName x

to :: Rep FirstName x -> FirstName

ToJSON FirstName

Methods

toJSON :: FirstName -> Value

toEncoding :: FirstName -> Encoding

toJSONList :: [FirstName] -> Value

toEncodingList :: [FirstName] -> Encoding

FromJSON FirstName

Methods

parseJSON :: Value -> Parser FirstName

parseJSONList :: Value -> Parser [FirstName]

type Rep FirstName

type Rep FirstName = D1 * (MetaData "FirstName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "FirstName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype LastName

Last name of user.

Constructors

LastName Text

Instances

Eq LastName

Methods

(==) :: LastName -> LastName -> Bool

(/=) :: LastName -> LastName -> Bool

Show LastName

Methods

showsPrec :: Int -> LastName -> ShowS

show :: LastName -> String

showList :: [LastName] -> ShowS

Generic LastName

Associated Types

type Rep LastName :: * -> *

Methods

from :: LastName -> Rep LastName x

to :: Rep LastName x -> LastName

ToJSON LastName

Methods

toJSON :: LastName -> Value

toEncoding :: LastName -> Encoding

toJSONList :: [LastName] -> Value

toEncodingList :: [LastName] -> Encoding

FromJSON LastName

Methods

parseJSON :: Value -> Parser LastName

parseJSONList :: Value -> Parser [LastName]

type Rep LastName

type Rep LastName = D1 * (MetaData "LastName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "LastName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype AvatarUrl

URL pointing to image file of Avatar.

Constructors

AvatarUrl Text

Instances

Eq AvatarUrl

Methods

(==) :: AvatarUrl -> AvatarUrl -> Bool

(/=) :: AvatarUrl -> AvatarUrl -> Bool

Show AvatarUrl

Methods

showsPrec :: Int -> AvatarUrl -> ShowS

show :: AvatarUrl -> String

showList :: [AvatarUrl] -> ShowS

Generic AvatarUrl

Associated Types

type Rep AvatarUrl :: * -> *

Methods

from :: AvatarUrl -> Rep AvatarUrl x

to :: Rep AvatarUrl x -> AvatarUrl

ToJSON AvatarUrl

Methods

toJSON :: AvatarUrl -> Value

toEncoding :: AvatarUrl -> Encoding

toJSONList :: [AvatarUrl] -> Value

toEncodingList :: [AvatarUrl] -> Encoding

FromJSON AvatarUrl

Methods

parseJSON :: Value -> Parser AvatarUrl

parseJSONList :: Value -> Parser [AvatarUrl]

type Rep AvatarUrl

type Rep AvatarUrl = D1 * (MetaData "AvatarUrl" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "AvatarUrl" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype Timezone

Timezone in timezone name.

Constructors

Timezone Text

Instances

Eq Timezone

Methods

(==) :: Timezone -> Timezone -> Bool

(/=) :: Timezone -> Timezone -> Bool

Show Timezone

Methods

showsPrec :: Int -> Timezone -> ShowS

show :: Timezone -> String

showList :: [Timezone] -> ShowS

Generic Timezone

Associated Types

type Rep Timezone :: * -> *

Methods

from :: Timezone -> Rep Timezone x

to :: Rep Timezone x -> Timezone

ToJSON Timezone

Methods

toJSON :: Timezone -> Value

toEncoding :: Timezone -> Encoding

toJSONList :: [Timezone] -> Value

toEncodingList :: [Timezone] -> Encoding

FromJSON Timezone

Methods

parseJSON :: Value -> Parser Timezone

parseJSONList :: Value -> Parser [Timezone]

type Rep Timezone

type Rep Timezone = D1 * (MetaData "Timezone" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "Timezone" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

data PersonStatus

Current status of Person. It can be updated automatically by recent activity or explicitly updated by user's operation or propagated from vacation setting on email system.

Constructors

PersonStatusActive

The Person is currently active. Decoded from "active".

PersonStatusInactive

The Person is currently not active. Decoded from "inactive".

PersonStatusOutOfOffice

Email system of the Person currently sets vacation. Decoded from "OutOfOffice".

PersonStatusDoNotDisturb

The Person is explicitly indicated do-not-disturb. Decoded from "DoNotDisturb".

PersonStatusUnknown

The status of the Person is unknown. Decoded from "unknown".

Instances

Eq PersonStatus

Methods

(==) :: PersonStatus -> PersonStatus -> Bool

(/=) :: PersonStatus -> PersonStatus -> Bool

Show PersonStatus

Methods

showsPrec :: Int -> PersonStatus -> ShowS

show :: PersonStatus -> String

showList :: [PersonStatus] -> ShowS

Generic PersonStatus

Associated Types

type Rep PersonStatus :: * -> *

Methods

from :: PersonStatus -> Rep PersonStatus x

to :: Rep PersonStatus x -> PersonStatus

ToJSON PersonStatus

PersonStatus implements toEncoding to encode each constructor into JSON enum value.

Methods

toJSON :: PersonStatus -> Value

toEncoding :: PersonStatus -> Encoding

toJSONList :: [PersonStatus] -> Value

toEncodingList :: [PersonStatus] -> Encoding

FromJSON PersonStatus

PersonStatus implements parseJSON to decode JSON enum value to a constructor.

Methods

parseJSON :: Value -> Parser PersonStatus

parseJSONList :: Value -> Parser [PersonStatus]

type Rep PersonStatus

type Rep PersonStatus = D1 * (MetaData "PersonStatus" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" False) ((:+:) * ((:+:) * (C1 * (MetaCons "PersonStatusActive" PrefixI False) (U1 *)) (C1 * (MetaCons "PersonStatusInactive" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "PersonStatusOutOfOffice" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "PersonStatusDoNotDisturb" PrefixI False) (U1 *)) (C1 * (MetaCons "PersonStatusUnknown" PrefixI False) (U1 *)))))

data PersonType

PersonType indicates whether the Person is real human or bot.

Constructors

PersonTypePerson

The Person is a real human. Decoded from "person".

PersonTypeBot

The Person is a bot. Decoded from "bot".

Instances

Eq PersonType

Methods

(==) :: PersonType -> PersonType -> Bool

(/=) :: PersonType -> PersonType -> Bool

Show PersonType

Methods

showsPrec :: Int -> PersonType -> ShowS

show :: PersonType -> String

showList :: [PersonType] -> ShowS

ToJSON PersonType

Methods

toJSON :: PersonType -> Value

toEncoding :: PersonType -> Encoding

toJSONList :: [PersonType] -> Value

toEncodingList :: [PersonType] -> Encoding

FromJSON PersonType

PersonType derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser PersonType

parseJSONList :: Value -> Parser [PersonType]

newtype PersonList

PersonList is decoded from response JSON of List People REST call. It is list of Person.

Constructors

PersonList

Fields

• personListItems :: [Person]

Instances

Eq PersonList

Methods

(==) :: PersonList -> PersonList -> Bool

(/=) :: PersonList -> PersonList -> Bool

Show PersonList

Methods

showsPrec :: Int -> PersonList -> ShowS

show :: PersonList -> String

showList :: [PersonList] -> ShowS

ToJSON PersonList

Methods

toJSON :: PersonList -> Value

toEncoding :: PersonList -> Encoding

toJSONList :: [PersonList] -> Value

toEncodingList :: [PersonList] -> Encoding

FromJSON PersonList

PersonList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser PersonList

parseJSONList :: Value -> Parser [PersonList]

data PersonFilter

Optional query strings for people list API.

Constructors

PersonFilter

Fields

• personFilterEmail :: Maybe Email

  Find person who has given email address.

• personFilterDisplayName :: Maybe DisplayName

  Find person who has given display name.

• personFilterOrgId :: Maybe OrganizationId

  Find person who belongs to given organization.

Instances

Eq PersonFilter

Methods

(==) :: PersonFilter -> PersonFilter -> Bool

(/=) :: PersonFilter -> PersonFilter -> Bool

Show PersonFilter

Methods

showsPrec :: Int -> PersonFilter -> ShowS

show :: PersonFilter -> String

showList :: [PersonFilter] -> ShowS

Generic PersonFilter

Associated Types

type Rep PersonFilter :: * -> *

Methods

from :: PersonFilter -> Rep PersonFilter x

to :: Rep PersonFilter x -> PersonFilter

Default PersonFilter

Methods

def :: PersonFilter

SparkFilter PersonFilter

User can list people with filter parameter.

Methods

toFilterList :: PersonFilter -> [(ByteString, Maybe ByteString)]

SparkResponse PersonFilter

List people API uses PersonFilter and responses Person.

Associated Types

type ToResponse PersonFilter :: *

SparkApiPath PersonFilter

List people API uses PersonFilter and path "people".

Methods

apiPath :: PersonFilter -> ByteString

type Rep PersonFilter

type Rep PersonFilter = D1 * (MetaData "PersonFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" False) (C1 * (MetaCons "PersonFilter" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "personFilterEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Email))) ((:*:) * (S1 * (MetaSel (Just Symbol "personFilterDisplayName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe DisplayName))) (S1 * (MetaSel (Just Symbol "personFilterOrgId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe OrganizationId))))))

type ToResponse PersonFilter

type ToResponse PersonFilter = Person

data CreatePerson

CreatePerson is encoded to request body JSON of Create a Person REST call.

Constructors

CreatePerson

Fields

• createPersonEmails :: Maybe [Email]

  List of email addresses which the Person has.

• createPersonDisplayName :: Maybe DisplayName

  Display name of the Person.

• createPersonFirstName :: Maybe FirstName

  First name of the Person.

• createPersonLastName :: Maybe LastName

  Last name of the Person.

• createPersonAvatar :: Maybe AvatarUrl

  URL pointing a image used for Avatar of the Person.

• createPersonOrgId :: Maybe OrganizationId

  Organization which the Person belongs to.

• createPersonRoles :: Maybe [RoleId]

  List of roles assigned to the person.

• createPersonLicenses :: Maybe [LicenseId]

  List of licenses effective on the Person.

Instances

Eq CreatePerson

Methods

(==) :: CreatePerson -> CreatePerson -> Bool

(/=) :: CreatePerson -> CreatePerson -> Bool

Show CreatePerson

Methods

showsPrec :: Int -> CreatePerson -> ShowS

show :: CreatePerson -> String

showList :: [CreatePerson] -> ShowS

ToJSON CreatePerson

Methods

toJSON :: CreatePerson -> Value

toEncoding :: CreatePerson -> Encoding

toJSONList :: [CreatePerson] -> Value

toEncodingList :: [CreatePerson] -> Encoding

FromJSON CreatePerson

CreatePerson derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser CreatePerson

parseJSONList :: Value -> Parser [CreatePerson]

SparkCreate CreatePerson

User can create a person.

SparkResponse CreatePerson

Create person API uses "CreatePerson' and responses Person.

Associated Types

type ToResponse CreatePerson :: *

SparkApiPath CreatePerson

Create person API uses CreatePerson and path "people".

Methods

apiPath :: CreatePerson -> ByteString

type ToResponse CreatePerson

type ToResponse CreatePerson = Person

data UpdatePerson

UpdatePerson is encoded to request body JSON of Update a Person REST call.

Constructors

UpdatePerson

Fields

• updatePersonDisplayName :: Maybe DisplayName

  Display name of the Person.

• updatePersonFirstName :: Maybe FirstName

  First name of the Person.

• updatePersonLastName :: Maybe LastName

  Last name of the Person.

• updatePersonAvatar :: Maybe AvatarUrl

  URL pointing a image used for Avatar of the Person.

• updatePersonOrgId :: Maybe OrganizationId

  Organization which the Person belongs to.

• updatePersonRoles :: Maybe [RoleId]

  List of roles assigned to the person.

• updatePersonLicenses :: Maybe [LicenseId]

  List of licenses effective on the Person.

Instances

Eq UpdatePerson

Methods

(==) :: UpdatePerson -> UpdatePerson -> Bool

(/=) :: UpdatePerson -> UpdatePerson -> Bool

Show UpdatePerson

Methods

showsPrec :: Int -> UpdatePerson -> ShowS

show :: UpdatePerson -> String

showList :: [UpdatePerson] -> ShowS

ToJSON UpdatePerson

Methods

toJSON :: UpdatePerson -> Value

toEncoding :: UpdatePerson -> Encoding

toJSONList :: [UpdatePerson] -> Value

toEncodingList :: [UpdatePerson] -> Encoding

FromJSON UpdatePerson

UpdatePerson derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser UpdatePerson

parseJSONList :: Value -> Parser [UpdatePerson]

SparkUpdate UpdatePerson

User can update a person.

SparkResponse UpdatePerson

Update person API uses "UpdatePerson' and responses Person.

Associated Types

type ToResponse UpdatePerson :: *

SparkApiPath UpdatePerson

Update person API uses UpdatePerson and path "people".

Methods

apiPath :: UpdatePerson -> ByteString

type ToResponse UpdatePerson

type ToResponse UpdatePerson = Person

Room related types

data Room

Room is communication space in Cisco Spark and called "Space" on UI. Historically it was called Room on UI too but UI has been changed to "Space" in order to avoid confusion with the concept "Room" associated to hardware facility of video conferencing on Spark. The name of Room is kept unchanged for backward compatibility.

Room is decoded from response JSON of Get Room Details REST call. It is also element type of response of List Rooms call.

Constructors

Room

Fields

• roomId :: RoomId

  Identifier of the Room.

• roomErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• roomTitle :: Maybe RoomTitle

  Title text of the Room.

• roomType :: Maybe RoomType

  Indicates if the Room is for 1:1 or group.

• roomIsLocked :: Maybe Bool

  True if the Room is locked.

• roomSipAddress :: Maybe SipAddr

  SIP address of the Room.

• roomLastActivity :: Maybe Timestamp

  Timestamp when the last activity was happen on the Room.

• roomTeamId :: Maybe TeamId

  Identifier of the Team which the Room belongs to.

• roomCreatorId :: Maybe PersonId

  Identifier of Person who created the Room.

• roomCreated :: Maybe Timestamp

  Timestamp when the Room was created.

Instances

Eq Room

Methods

(==) :: Room -> Room -> Bool

(/=) :: Room -> Room -> Bool

Show Room

Methods

showsPrec :: Int -> Room -> ShowS

show :: Room -> String

showList :: [Room] -> ShowS

ToJSON Room

Methods

toJSON :: Room -> Value

toEncoding :: Room -> Encoding

toJSONList :: [Room] -> Value

toEncodingList :: [Room] -> Encoding

FromJSON Room

Room derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Room

parseJSONList :: Value -> Parser [Room]

SparkListItem Room

RoomList wraps Room

Associated Types

type ToList Room :: *

Methods

unwrap :: ToList Room -> [Room]

type ToList Room

type ToList Room = RoomList

newtype RoomId

Identifying Room.

Constructors

RoomId Text

Instances

Eq RoomId

Methods

(==) :: RoomId -> RoomId -> Bool

(/=) :: RoomId -> RoomId -> Bool

Show RoomId

Methods

showsPrec :: Int -> RoomId -> ShowS

show :: RoomId -> String

showList :: [RoomId] -> ShowS

Generic RoomId

Associated Types

type Rep RoomId :: * -> *

Methods

from :: RoomId -> Rep RoomId x

to :: Rep RoomId x -> RoomId

ToJSON RoomId

Methods

toJSON :: RoomId -> Value

toEncoding :: RoomId -> Encoding

toJSONList :: [RoomId] -> Value

toEncodingList :: [RoomId] -> Encoding

FromJSON RoomId

Methods

parseJSON :: Value -> Parser RoomId

parseJSONList :: Value -> Parser [RoomId]

SparkDetail RoomId

User can get detail of a room.

Methods

toIdStr :: RoomId -> Text

SparkResponse RoomId

Get detail for a room API uses "RoomId' and responses Room.

Associated Types

type ToResponse RoomId :: *

SparkApiPath RoomId

Get detail for a room API uses RoomId and path "rooms".

Methods

apiPath :: RoomId -> ByteString

type Rep RoomId

type Rep RoomId = D1 * (MetaData "RoomId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "RoomId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse RoomId

type ToResponse RoomId = Room

newtype RoomTitle

Title text of Room.

Constructors

RoomTitle Text

Instances

Eq RoomTitle

Methods

(==) :: RoomTitle -> RoomTitle -> Bool

(/=) :: RoomTitle -> RoomTitle -> Bool

Show RoomTitle

Methods

showsPrec :: Int -> RoomTitle -> ShowS

show :: RoomTitle -> String

showList :: [RoomTitle] -> ShowS

Generic RoomTitle

Associated Types

type Rep RoomTitle :: * -> *

Methods

from :: RoomTitle -> Rep RoomTitle x

to :: Rep RoomTitle x -> RoomTitle

ToJSON RoomTitle

Methods

toJSON :: RoomTitle -> Value

toEncoding :: RoomTitle -> Encoding

toJSONList :: [RoomTitle] -> Value

toEncodingList :: [RoomTitle] -> Encoding

FromJSON RoomTitle

Methods

parseJSON :: Value -> Parser RoomTitle

parseJSONList :: Value -> Parser [RoomTitle]

type Rep RoomTitle

type Rep RoomTitle = D1 * (MetaData "RoomTitle" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "RoomTitle" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

data RoomType

RoomType indicates if the Room is for 1:1 user or group of users.

Constructors

RoomTypeDirect

The Room is for 1:1. Decoded from "direct".

RoomTypeGroup

The Room is for group. Decoded from "group".

Instances

Eq RoomType

Methods

(==) :: RoomType -> RoomType -> Bool

(/=) :: RoomType -> RoomType -> Bool

Show RoomType

Methods

showsPrec :: Int -> RoomType -> ShowS

show :: RoomType -> String

showList :: [RoomType] -> ShowS

ToJSON RoomType

Methods

toJSON :: RoomType -> Value

toEncoding :: RoomType -> Encoding

toJSONList :: [RoomType] -> Value

toEncodingList :: [RoomType] -> Encoding

FromJSON RoomType

RoomType derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser RoomType

parseJSONList :: Value -> Parser [RoomType]

newtype SipAddr

SIP address.

Constructors

SipAddr Text

Instances

Eq SipAddr

Methods

(==) :: SipAddr -> SipAddr -> Bool

(/=) :: SipAddr -> SipAddr -> Bool

Show SipAddr

Methods

showsPrec :: Int -> SipAddr -> ShowS

show :: SipAddr -> String

showList :: [SipAddr] -> ShowS

Generic SipAddr

Associated Types

type Rep SipAddr :: * -> *

Methods

from :: SipAddr -> Rep SipAddr x

to :: Rep SipAddr x -> SipAddr

ToJSON SipAddr

Methods

toJSON :: SipAddr -> Value

toEncoding :: SipAddr -> Encoding

toJSONList :: [SipAddr] -> Value

toEncodingList :: [SipAddr] -> Encoding

FromJSON SipAddr

Methods

parseJSON :: Value -> Parser SipAddr

parseJSONList :: Value -> Parser [SipAddr]

type Rep SipAddr

type Rep SipAddr = D1 * (MetaData "SipAddr" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "SipAddr" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype RoomList

RoomList is decoded from response JSON of List Rooms REST call. It is list of Room.

Constructors

RoomList

Fields

• roomListItems :: [Room]

Instances

Eq RoomList

Methods

(==) :: RoomList -> RoomList -> Bool

(/=) :: RoomList -> RoomList -> Bool

Show RoomList

Methods

showsPrec :: Int -> RoomList -> ShowS

show :: RoomList -> String

showList :: [RoomList] -> ShowS

ToJSON RoomList

Methods

toJSON :: RoomList -> Value

toEncoding :: RoomList -> Encoding

toJSONList :: [RoomList] -> Value

toEncodingList :: [RoomList] -> Encoding

FromJSON RoomList

RoomList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser RoomList

parseJSONList :: Value -> Parser [RoomList]

data RoomFilter

Optional query strings for room list API

Constructors

RoomFilter

Fields

• roomFilterTeamId :: Maybe TeamId

  List rooms only in given team.

• roomFilterRoomType :: Maybe RoomType

  List given type rooms only.

• roomFilterSortBy :: Maybe RoomFilterSortBy

  Sort response by given option.

Instances

Eq RoomFilter

Methods

(==) :: RoomFilter -> RoomFilter -> Bool

(/=) :: RoomFilter -> RoomFilter -> Bool

Show RoomFilter

Methods

showsPrec :: Int -> RoomFilter -> ShowS

show :: RoomFilter -> String

showList :: [RoomFilter] -> ShowS

Generic RoomFilter

Associated Types

type Rep RoomFilter :: * -> *

Methods

from :: RoomFilter -> Rep RoomFilter x

to :: Rep RoomFilter x -> RoomFilter

Default RoomFilter

Methods

def :: RoomFilter

SparkFilter RoomFilter

User can list rooms with filter parameter.

Methods

toFilterList :: RoomFilter -> [(ByteString, Maybe ByteString)]

SparkResponse RoomFilter

List rooms API uses RoomFilter and responses Room.

Associated Types

type ToResponse RoomFilter :: *

SparkApiPath RoomFilter

List rooms API uses RoomFilter and path "rooms".

Methods

apiPath :: RoomFilter -> ByteString

type Rep RoomFilter

type Rep RoomFilter = D1 * (MetaData "RoomFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" False) (C1 * (MetaCons "RoomFilter" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "roomFilterTeamId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe TeamId))) ((:*:) * (S1 * (MetaSel (Just Symbol "roomFilterRoomType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe RoomType))) (S1 * (MetaSel (Just Symbol "roomFilterSortBy") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe RoomFilterSortBy))))))

type ToResponse RoomFilter

type ToResponse RoomFilter = Room

data RoomFilterSortBy

Sorting option for room list API.

Constructors

RoomFilterSortById

RoomFilterSortByLastActivity

RoomFilterSortByCreated

Instances

Eq RoomFilterSortBy

Methods

(==) :: RoomFilterSortBy -> RoomFilterSortBy -> Bool

(/=) :: RoomFilterSortBy -> RoomFilterSortBy -> Bool

Show RoomFilterSortBy

Methods

showsPrec :: Int -> RoomFilterSortBy -> ShowS

show :: RoomFilterSortBy -> String

showList :: [RoomFilterSortBy] -> ShowS

data CreateRoom

CreateRoom is encoded to request body JSON of Create a Room REST call.

Constructors

CreateRoom

Fields

• createRoomTitle :: RoomTitle

  Title text of newly created Room.

• createRoomTeamId :: Maybe TeamId

  Identifier of Team which the Room will belong to. If Nothing, the new Room will be standalone.

Instances

Eq CreateRoom

Methods

(==) :: CreateRoom -> CreateRoom -> Bool

(/=) :: CreateRoom -> CreateRoom -> Bool

Show CreateRoom

Methods

showsPrec :: Int -> CreateRoom -> ShowS

show :: CreateRoom -> String

showList :: [CreateRoom] -> ShowS

ToJSON CreateRoom

Methods

toJSON :: CreateRoom -> Value

toEncoding :: CreateRoom -> Encoding

toJSONList :: [CreateRoom] -> Value

toEncodingList :: [CreateRoom] -> Encoding

FromJSON CreateRoom

CreateRoom derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser CreateRoom

parseJSONList :: Value -> Parser [CreateRoom]

SparkCreate CreateRoom

User can create a room.

SparkResponse CreateRoom

Create room API uses "CreateRoom' and responses Room.

Associated Types

type ToResponse CreateRoom :: *

SparkApiPath CreateRoom

Create room API uses CreateRoom and path "rooms".

Methods

apiPath :: CreateRoom -> ByteString

type ToResponse CreateRoom

type ToResponse CreateRoom = Room

newtype UpdateRoom

UpdateRoom is encoded to request body JSON of Update a Room REST call.

Constructors

UpdateRoom

Fields

• updateRoomTitle :: RoomTitle

Instances

Eq UpdateRoom

Methods

(==) :: UpdateRoom -> UpdateRoom -> Bool

(/=) :: UpdateRoom -> UpdateRoom -> Bool

Show UpdateRoom

Methods

showsPrec :: Int -> UpdateRoom -> ShowS

show :: UpdateRoom -> String

showList :: [UpdateRoom] -> ShowS

ToJSON UpdateRoom

Methods

toJSON :: UpdateRoom -> Value

toEncoding :: UpdateRoom -> Encoding

toJSONList :: [UpdateRoom] -> Value

toEncodingList :: [UpdateRoom] -> Encoding

FromJSON UpdateRoom

UpdateRoom derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser UpdateRoom

parseJSONList :: Value -> Parser [UpdateRoom]

SparkUpdate UpdateRoom

User can update a room.

SparkResponse UpdateRoom

Update room API uses "UpdateRoom' and responses Room.

Associated Types

type ToResponse UpdateRoom :: *

SparkApiPath UpdateRoom

Update room API uses UpdateRoom and path "rooms".

Methods

apiPath :: UpdateRoom -> ByteString

type ToResponse UpdateRoom

type ToResponse UpdateRoom = Room

Membership related types

data Membership

Membership is association between Room and Person. It can be N:N relation. A Person can belong to multiple Room. Membership is decoded from response JSON of Get Membership Details REST call. It is also element type of response of List Memberships call.

Constructors

Membership

Fields

• membershipId :: MembershipId

  Identifier of the Membership entry.

• membershipErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• membershipRoomId :: Maybe RoomId

  Identifier of the Room associated to the Person

• membershipPersonId :: Maybe PersonId

  Identifier of the Person associated to the Room

• membershipPersonEmail :: Maybe Email

  Email of the Person

• membershipPersonDisplayName :: Maybe DisplayName

  Display name of the Person

• membershipPersonOrgId :: Maybe OrganizationId

  Identifier of Organization which the Person belongs to.

• membershipIsModerator :: Maybe Bool

  True if the Person is a moderator of the room.

• membershipIsMonitor :: Maybe Bool

  True if the Person is monitoring the Room.

• membershipCreated :: Maybe Timestamp

  Timestamp when the Membership was created.

Instances

Eq Membership

Methods

(==) :: Membership -> Membership -> Bool

(/=) :: Membership -> Membership -> Bool

Show Membership

Methods

showsPrec :: Int -> Membership -> ShowS

show :: Membership -> String

showList :: [Membership] -> ShowS

ToJSON Membership

Methods

toJSON :: Membership -> Value

toEncoding :: Membership -> Encoding

toJSONList :: [Membership] -> Value

toEncodingList :: [Membership] -> Encoding

FromJSON Membership

Membership derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Membership

parseJSONList :: Value -> Parser [Membership]

SparkListItem Membership

MembershipList wraps Membership

Associated Types

type ToList Membership :: *

Methods

unwrap :: ToList Membership -> [Membership]

type ToList Membership

type ToList Membership = MembershipList

newtype MembershipId

Identifying Membership.

Constructors

MembershipId Text

Instances

Eq MembershipId

Methods

(==) :: MembershipId -> MembershipId -> Bool

(/=) :: MembershipId -> MembershipId -> Bool

Show MembershipId

Methods

showsPrec :: Int -> MembershipId -> ShowS

show :: MembershipId -> String

showList :: [MembershipId] -> ShowS

Generic MembershipId

Associated Types

type Rep MembershipId :: * -> *

Methods

from :: MembershipId -> Rep MembershipId x

to :: Rep MembershipId x -> MembershipId

ToJSON MembershipId

Methods

toJSON :: MembershipId -> Value

toEncoding :: MembershipId -> Encoding

toJSONList :: [MembershipId] -> Value

toEncodingList :: [MembershipId] -> Encoding

FromJSON MembershipId

Methods

parseJSON :: Value -> Parser MembershipId

parseJSONList :: Value -> Parser [MembershipId]

SparkDetail MembershipId

User can get detail of a membership.

Methods

toIdStr :: MembershipId -> Text

SparkResponse MembershipId

Get detail for a membership API uses "MembershipId' and responses Membership.

Associated Types

type ToResponse MembershipId :: *

SparkApiPath MembershipId

Get detail for a membership API uses MembershipId and path "memberships".

Methods

apiPath :: MembershipId -> ByteString

type Rep MembershipId

type Rep MembershipId = D1 * (MetaData "MembershipId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "MembershipId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse MembershipId

type ToResponse MembershipId = Membership

newtype MembershipList

MembershipList is decoded from response JSON of List Memberships REST call. It is list of Membership.

Constructors

MembershipList

Fields

• membershipListItems :: [Membership]

Instances

Eq MembershipList

Methods

(==) :: MembershipList -> MembershipList -> Bool

(/=) :: MembershipList -> MembershipList -> Bool

Show MembershipList

Methods

showsPrec :: Int -> MembershipList -> ShowS

show :: MembershipList -> String

showList :: [MembershipList] -> ShowS

ToJSON MembershipList

Methods

toJSON :: MembershipList -> Value

toEncoding :: MembershipList -> Encoding

toJSONList :: [MembershipList] -> Value

toEncodingList :: [MembershipList] -> Encoding

FromJSON MembershipList

MembershipList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser MembershipList

parseJSONList :: Value -> Parser [MembershipList]

data MembershipFilter

Optional query strings for room membership list API

Constructors

MembershipFilter

Fields

• membershipFilterRoomId :: Maybe RoomId

  List membership only in given room.

• membershipFilterPersonId :: Maybe PersonId

  List membership related to given person of personId.

• membershipFilterPersonEmail :: Maybe Email

  List membership related to given person of email.

Instances

Eq MembershipFilter

Methods

(==) :: MembershipFilter -> MembershipFilter -> Bool

(/=) :: MembershipFilter -> MembershipFilter -> Bool

Show MembershipFilter

Methods

showsPrec :: Int -> MembershipFilter -> ShowS

show :: MembershipFilter -> String

showList :: [MembershipFilter] -> ShowS

Generic MembershipFilter

Associated Types

type Rep MembershipFilter :: * -> *

Methods

from :: MembershipFilter -> Rep MembershipFilter x

to :: Rep MembershipFilter x -> MembershipFilter

Default MembershipFilter

Methods

def :: MembershipFilter

SparkFilter MembershipFilter

User can list memberships with filter parameter.

Methods

toFilterList :: MembershipFilter -> [(ByteString, Maybe ByteString)]

SparkResponse MembershipFilter

List memberships API uses MembershipFilter and responses Membership.

Associated Types

type ToResponse MembershipFilter :: *

SparkApiPath MembershipFilter

List memberships API uses MembershipFilter and path "memberships".

Methods

apiPath :: MembershipFilter -> ByteString

type Rep MembershipFilter

type Rep MembershipFilter = D1 * (MetaData "MembershipFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" False) (C1 * (MetaCons "MembershipFilter" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "membershipFilterRoomId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe RoomId))) ((:*:) * (S1 * (MetaSel (Just Symbol "membershipFilterPersonId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe PersonId))) (S1 * (MetaSel (Just Symbol "membershipFilterPersonEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Email))))))

type ToResponse MembershipFilter

type ToResponse MembershipFilter = Membership

data CreateMembership

CreateMembership is encoded to request body JSON of Create a Membership REST call.

Constructors

CreateMembership

Fields

• createMembershipRoomId :: RoomId

  Identifier of Room which the Person will be added to.

• createMembershipPersonId :: Maybe PersonId

  Identifier of Person who will be added to the Room.

• createMembershipPersonEmail :: Maybe Email

  Email of the Person to be added.

• createMembershipIsModerator :: Maybe Bool

  The Person becomes a moderator of the Room if True.

Instances

Eq CreateMembership

Methods

(==) :: CreateMembership -> CreateMembership -> Bool

(/=) :: CreateMembership -> CreateMembership -> Bool

Show CreateMembership

Methods

showsPrec :: Int -> CreateMembership -> ShowS

show :: CreateMembership -> String

showList :: [CreateMembership] -> ShowS

ToJSON CreateMembership

Methods

toJSON :: CreateMembership -> Value

toEncoding :: CreateMembership -> Encoding

toJSONList :: [CreateMembership] -> Value

toEncodingList :: [CreateMembership] -> Encoding

FromJSON CreateMembership

CreateMembership derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser CreateMembership

parseJSONList :: Value -> Parser [CreateMembership]

SparkCreate CreateMembership

User can create a membership.

SparkResponse CreateMembership

Create membership API uses "CreateMembership' and responses Membership.

Associated Types

type ToResponse CreateMembership :: *

SparkApiPath CreateMembership

Create membership API uses CreateMembership and path "memberships".

Methods

apiPath :: CreateMembership -> ByteString

type ToResponse CreateMembership

type ToResponse CreateMembership = Membership

newtype UpdateMembership

UpdateMembership is encoded to request body JSON of Update a Membership REST call.

Constructors

UpdateMembership

Fields

• updateMembershipIsModerator :: Bool

Instances

Eq UpdateMembership

Methods

(==) :: UpdateMembership -> UpdateMembership -> Bool

(/=) :: UpdateMembership -> UpdateMembership -> Bool

Show UpdateMembership

Methods

showsPrec :: Int -> UpdateMembership -> ShowS

show :: UpdateMembership -> String

showList :: [UpdateMembership] -> ShowS

ToJSON UpdateMembership

Methods

toJSON :: UpdateMembership -> Value

toEncoding :: UpdateMembership -> Encoding

toJSONList :: [UpdateMembership] -> Value

toEncodingList :: [UpdateMembership] -> Encoding

FromJSON UpdateMembership

UpdateMembership derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser UpdateMembership

parseJSONList :: Value -> Parser [UpdateMembership]

SparkUpdate UpdateMembership

User can update a membership.

SparkResponse UpdateMembership

Update membership API uses "UpdateMembership' and responses Membership.

Associated Types

type ToResponse UpdateMembership :: *

SparkApiPath UpdateMembership

Update membership API uses UpdateMembership and path "memberships".

Methods

apiPath :: UpdateMembership -> ByteString

type ToResponse UpdateMembership

type ToResponse UpdateMembership = Membership

Message related types

data Message

Message is a message posted to a Room by some Person. Room is decoded from response JSON of Get Message Details REST call. It is also element type of response of List Messages call.

Constructors

Message

Fields

• messageId :: MessageId

  Identifier of the Message.

• messageErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• messageRoomId :: Maybe RoomId

  Identifier of the room where the Message was sent.

• messageRoomType :: Maybe RoomType

  Type of Room the message was sent to.

• messageToPersonId :: Maybe PersonId

  Presents in documentation but doesn't appear in actual API response.

• messageToPersonEmail :: Maybe Email

  Presents in documentation but doesn't appear in actual API response.

• messageText :: Maybe MessageText

  Message body in plain text.

• messageHtml :: Maybe MessageHtml

  Message body in HTML.

• messageFiles :: Maybe [FileUrl]

  URL to files attached to the message.

• messagePersonId :: Maybe PersonId

  Identifier of Person who sent the message.

• messagePersonEmail :: Maybe Email

  Email of Person who sent the message.

• messageCreated :: Maybe Timestamp

  Timestamp when the massage was sent.

• messageMentionedPeople :: Maybe [PersonId]

  List of identifiers of Person were mentioned in the message.

Instances

Eq Message

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

Show Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

ToJSON Message

Methods

toJSON :: Message -> Value

toEncoding :: Message -> Encoding

toJSONList :: [Message] -> Value

toEncodingList :: [Message] -> Encoding

FromJSON Message

Message derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Message

parseJSONList :: Value -> Parser [Message]

SparkListItem Message

MessageList wraps Message

Associated Types

type ToList Message :: *

Methods

unwrap :: ToList Message -> [Message]

type ToList Message

type ToList Message = MessageList

newtype MessageId

Identifying Message.

Constructors

MessageId Text

Instances

Eq MessageId

Methods

(==) :: MessageId -> MessageId -> Bool

(/=) :: MessageId -> MessageId -> Bool

Show MessageId

Methods

showsPrec :: Int -> MessageId -> ShowS

show :: MessageId -> String

showList :: [MessageId] -> ShowS

Generic MessageId

Associated Types

type Rep MessageId :: * -> *

Methods

from :: MessageId -> Rep MessageId x

to :: Rep MessageId x -> MessageId

ToJSON MessageId

Methods

toJSON :: MessageId -> Value

toEncoding :: MessageId -> Encoding

toJSONList :: [MessageId] -> Value

toEncodingList :: [MessageId] -> Encoding

FromJSON MessageId

Methods

parseJSON :: Value -> Parser MessageId

parseJSONList :: Value -> Parser [MessageId]

SparkDetail MessageId

User can get detail of a message.

Methods

toIdStr :: MessageId -> Text

SparkResponse MessageId

Get detail for a message API uses "MessageId' and responses Message.

Associated Types

type ToResponse MessageId :: *

SparkApiPath MessageId

Get detail for message API uses MessageId and path "messages".

Methods

apiPath :: MessageId -> ByteString

type Rep MessageId

type Rep MessageId = D1 * (MetaData "MessageId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "MessageId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse MessageId

type ToResponse MessageId = Message

newtype MessageText

Body of message in plain text.

Constructors

MessageText Text

Instances

Eq MessageText

Methods

(==) :: MessageText -> MessageText -> Bool

(/=) :: MessageText -> MessageText -> Bool

Show MessageText

Methods

showsPrec :: Int -> MessageText -> ShowS

show :: MessageText -> String

showList :: [MessageText] -> ShowS

Generic MessageText

Associated Types

type Rep MessageText :: * -> *

Methods

from :: MessageText -> Rep MessageText x

to :: Rep MessageText x -> MessageText

ToJSON MessageText

Methods

toJSON :: MessageText -> Value

toEncoding :: MessageText -> Encoding

toJSONList :: [MessageText] -> Value

toEncodingList :: [MessageText] -> Encoding

FromJSON MessageText

Methods

parseJSON :: Value -> Parser MessageText

parseJSONList :: Value -> Parser [MessageText]

type Rep MessageText

type Rep MessageText = D1 * (MetaData "MessageText" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "MessageText" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype MessageHtml

Body of message in html.

Constructors

MessageHtml Text

Instances

Eq MessageHtml

Methods

(==) :: MessageHtml -> MessageHtml -> Bool

(/=) :: MessageHtml -> MessageHtml -> Bool

Show MessageHtml

Methods

showsPrec :: Int -> MessageHtml -> ShowS

show :: MessageHtml -> String

showList :: [MessageHtml] -> ShowS

Generic MessageHtml

Associated Types

type Rep MessageHtml :: * -> *

Methods

from :: MessageHtml -> Rep MessageHtml x

to :: Rep MessageHtml x -> MessageHtml

ToJSON MessageHtml

Methods

toJSON :: MessageHtml -> Value

toEncoding :: MessageHtml -> Encoding

toJSONList :: [MessageHtml] -> Value

toEncodingList :: [MessageHtml] -> Encoding

FromJSON MessageHtml

Methods

parseJSON :: Value -> Parser MessageHtml

parseJSONList :: Value -> Parser [MessageHtml]

type Rep MessageHtml

type Rep MessageHtml = D1 * (MetaData "MessageHtml" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "MessageHtml" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype MessageMarkdown

Body of message in markdown.

Constructors

MessageMarkdown Text

Instances

Eq MessageMarkdown

Methods

(==) :: MessageMarkdown -> MessageMarkdown -> Bool

(/=) :: MessageMarkdown -> MessageMarkdown -> Bool

Show MessageMarkdown

Methods

showsPrec :: Int -> MessageMarkdown -> ShowS

show :: MessageMarkdown -> String

showList :: [MessageMarkdown] -> ShowS

Generic MessageMarkdown

Associated Types

type Rep MessageMarkdown :: * -> *

Methods

from :: MessageMarkdown -> Rep MessageMarkdown x

to :: Rep MessageMarkdown x -> MessageMarkdown

ToJSON MessageMarkdown

Methods

toJSON :: MessageMarkdown -> Value

toEncoding :: MessageMarkdown -> Encoding

toJSONList :: [MessageMarkdown] -> Value

toEncodingList :: [MessageMarkdown] -> Encoding

FromJSON MessageMarkdown

Methods

parseJSON :: Value -> Parser MessageMarkdown

parseJSONList :: Value -> Parser [MessageMarkdown]

type Rep MessageMarkdown

type Rep MessageMarkdown = D1 * (MetaData "MessageMarkdown" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "MessageMarkdown" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype FileUrl

URL pointing attached file of message.

Constructors

FileUrl Text

Instances

Eq FileUrl

Methods

(==) :: FileUrl -> FileUrl -> Bool

(/=) :: FileUrl -> FileUrl -> Bool

Show FileUrl

Methods

showsPrec :: Int -> FileUrl -> ShowS

show :: FileUrl -> String

showList :: [FileUrl] -> ShowS

Generic FileUrl

Associated Types

type Rep FileUrl :: * -> *

Methods

from :: FileUrl -> Rep FileUrl x

to :: Rep FileUrl x -> FileUrl

ToJSON FileUrl

Methods

toJSON :: FileUrl -> Value

toEncoding :: FileUrl -> Encoding

toJSONList :: [FileUrl] -> Value

toEncodingList :: [FileUrl] -> Encoding

FromJSON FileUrl

Methods

parseJSON :: Value -> Parser FileUrl

parseJSONList :: Value -> Parser [FileUrl]

type Rep FileUrl

type Rep FileUrl = D1 * (MetaData "FileUrl" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "FileUrl" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype MessageList

MessageList is decoded from response JSON of List Messages REST call. It is list of Message.

Constructors

MessageList

Fields

• messageListItems :: [Message]

Instances

Eq MessageList

Methods

(==) :: MessageList -> MessageList -> Bool

(/=) :: MessageList -> MessageList -> Bool

Show MessageList

Methods

showsPrec :: Int -> MessageList -> ShowS

show :: MessageList -> String

showList :: [MessageList] -> ShowS

ToJSON MessageList

Methods

toJSON :: MessageList -> Value

toEncoding :: MessageList -> Encoding

toJSONList :: [MessageList] -> Value

toEncodingList :: [MessageList] -> Encoding

FromJSON MessageList

MessageList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser MessageList

parseJSONList :: Value -> Parser [MessageList]

data MessageFilter

Optional query strings for message list API

Constructors

MessageFilter

Fields

• messageFilterRoomId :: RoomId

  Mandatory parameter which room to search.

• messageFilterMentionedPeople :: Maybe MentionedPeople

  List messages only mentioned to given person.

• messageFilterBefore :: Maybe Timestamp

  List messages posted before given timestamp.

• messageFilterBeforeMessage :: Maybe MessageId

  List messages posted before given message.

Instances

Eq MessageFilter

Methods

(==) :: MessageFilter -> MessageFilter -> Bool

(/=) :: MessageFilter -> MessageFilter -> Bool

Show MessageFilter

Methods

showsPrec :: Int -> MessageFilter -> ShowS

show :: MessageFilter -> String

showList :: [MessageFilter] -> ShowS

SparkFilter MessageFilter

User can list messages with filter parameter.

Methods

toFilterList :: MessageFilter -> [(ByteString, Maybe ByteString)]

SparkResponse MessageFilter

List messages API uses MessageFilter and responses Message.

Associated Types

type ToResponse MessageFilter :: *

SparkApiPath MessageFilter

List messages API uses MessageFilter and path "messages".

Methods

apiPath :: MessageFilter -> ByteString

type ToResponse MessageFilter

type ToResponse MessageFilter = Message

data MentionedPeople

Sum type for mentionedPeople query string. It can be "me" or PersonId.

Constructors

MentionedPeopleMe

MentionedPeople PersonId

Instances

Eq MentionedPeople

Methods

(==) :: MentionedPeople -> MentionedPeople -> Bool

(/=) :: MentionedPeople -> MentionedPeople -> Bool

Show MentionedPeople

Methods

showsPrec :: Int -> MentionedPeople -> ShowS

show :: MentionedPeople -> String

showList :: [MentionedPeople] -> ShowS

data CreateMessage

CreateMessage is encoded to request body JSON of Create a Message REST call.

Constructors

CreateMessage

Fields

• createMessageRoomId :: Maybe RoomId

  Identifier of the Room the message will be posted to.

• createMessageToPersonId :: Maybe PersonId

  Identifier of the Person to whom the direct message will be sent.

• createMessageToPersonEmail :: Maybe Email

  Email of Person who receives the Message.

• createMessageText :: Maybe MessageText

  Message body in plain text.

• createMessageMarkdown :: Maybe MessageMarkdown

  Message body in markdown format.

• createMessageFiles :: Maybe [FileUrl]

  URLs of Attached files to the message.

Instances

Eq CreateMessage

Methods

(==) :: CreateMessage -> CreateMessage -> Bool

(/=) :: CreateMessage -> CreateMessage -> Bool

Show CreateMessage

Methods

showsPrec :: Int -> CreateMessage -> ShowS

show :: CreateMessage -> String

showList :: [CreateMessage] -> ShowS

ToJSON CreateMessage

Methods

toJSON :: CreateMessage -> Value

toEncoding :: CreateMessage -> Encoding

toJSONList :: [CreateMessage] -> Value

toEncodingList :: [CreateMessage] -> Encoding

FromJSON CreateMessage

CreateMessage derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser CreateMessage

parseJSONList :: Value -> Parser [CreateMessage]

SparkCreate CreateMessage

User can create a message.

SparkResponse CreateMessage

Create message API uses "CreateMessage' and responses Message.

Associated Types

type ToResponse CreateMessage :: *

SparkApiPath CreateMessage

Create message API uses CreateMessage and path "messages".

Methods

apiPath :: CreateMessage -> ByteString

type ToResponse CreateMessage

type ToResponse CreateMessage = Message

Team related types

newtype TeamName

Name of Team

Constructors

TeamName Text

Instances

Eq TeamName

Methods

(==) :: TeamName -> TeamName -> Bool

(/=) :: TeamName -> TeamName -> Bool

Show TeamName

Methods

showsPrec :: Int -> TeamName -> ShowS

show :: TeamName -> String

showList :: [TeamName] -> ShowS

Generic TeamName

Associated Types

type Rep TeamName :: * -> *

Methods

from :: TeamName -> Rep TeamName x

to :: Rep TeamName x -> TeamName

ToJSON TeamName

Methods

toJSON :: TeamName -> Value

toEncoding :: TeamName -> Encoding

toJSONList :: [TeamName] -> Value

toEncodingList :: [TeamName] -> Encoding

FromJSON TeamName

Methods

parseJSON :: Value -> Parser TeamName

parseJSONList :: Value -> Parser [TeamName]

type Rep TeamName

type Rep TeamName = D1 * (MetaData "TeamName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "TeamName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype TeamId

Identifying Team.

Constructors

TeamId Text

Instances

Eq TeamId

Methods

(==) :: TeamId -> TeamId -> Bool

(/=) :: TeamId -> TeamId -> Bool

Show TeamId

Methods

showsPrec :: Int -> TeamId -> ShowS

show :: TeamId -> String

showList :: [TeamId] -> ShowS

Generic TeamId

Associated Types

type Rep TeamId :: * -> *

Methods

from :: TeamId -> Rep TeamId x

to :: Rep TeamId x -> TeamId

ToJSON TeamId

Methods

toJSON :: TeamId -> Value

toEncoding :: TeamId -> Encoding

toJSONList :: [TeamId] -> Value

toEncodingList :: [TeamId] -> Encoding

FromJSON TeamId

Methods

parseJSON :: Value -> Parser TeamId

parseJSONList :: Value -> Parser [TeamId]

SparkDetail TeamId

User can get detail of a team.

Methods

toIdStr :: TeamId -> Text

SparkResponse TeamId

Get detail for a team API uses "TeamId' and responses Team.

Associated Types

type ToResponse TeamId :: *

SparkApiPath TeamId

Get detail for a team API uses TeamId and path "teams".

Methods

apiPath :: TeamId -> ByteString

type Rep TeamId

type Rep TeamId = D1 * (MetaData "TeamId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "TeamId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse TeamId

type ToResponse TeamId = Team

data Team

Team is group of Person and group of Room. A Person can belong to multiple Team but a Room can belong to at most one Team. Team is decoded from response JSON of Get Team Details REST call. It is also element type of response of List Teams call.

Constructors

Team

Fields

• teamId :: TeamId

  Identifier of the Team.

• teamErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• teamName :: Maybe TeamName

  Name of the Team.

• teamCreatorId :: Maybe PersonId

  Identifier of the Person who created the Team.

• teamCreated :: Maybe Timestamp

  Timestamp when the Team was created.

Instances

Eq Team

Methods

(==) :: Team -> Team -> Bool

(/=) :: Team -> Team -> Bool

Show Team

Methods

showsPrec :: Int -> Team -> ShowS

show :: Team -> String

showList :: [Team] -> ShowS

ToJSON Team

Methods

toJSON :: Team -> Value

toEncoding :: Team -> Encoding

toJSONList :: [Team] -> Value

toEncodingList :: [Team] -> Encoding

FromJSON Team

Team derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Team

parseJSONList :: Value -> Parser [Team]

SparkListItem Team

TeamList wraps Team

Associated Types

type ToList Team :: *

Methods

unwrap :: ToList Team -> [Team]

type ToList Team

type ToList Team = TeamList

newtype TeamList

TeamList is decoded from response JSON of List Teams REST call. It is list of Team.

Constructors

TeamList

Fields

• teamListItems :: [Team]

Instances

Eq TeamList

Methods

(==) :: TeamList -> TeamList -> Bool

(/=) :: TeamList -> TeamList -> Bool

Show TeamList

Methods

showsPrec :: Int -> TeamList -> ShowS

show :: TeamList -> String

showList :: [TeamList] -> ShowS

ToJSON TeamList

Methods

toJSON :: TeamList -> Value

toEncoding :: TeamList -> Encoding

toJSONList :: [TeamList] -> Value

toEncodingList :: [TeamList] -> Encoding

FromJSON TeamList

TeamList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser TeamList

parseJSONList :: Value -> Parser [TeamList]

newtype CreateTeam

CreateTeam is encoded to request body JSON of Create a Team REST call.

Constructors

CreateTeam

Fields

• createTeamName :: TeamName

Instances

Eq CreateTeam

Methods

(==) :: CreateTeam -> CreateTeam -> Bool

(/=) :: CreateTeam -> CreateTeam -> Bool

Show CreateTeam

Methods

showsPrec :: Int -> CreateTeam -> ShowS

show :: CreateTeam -> String

showList :: [CreateTeam] -> ShowS

ToJSON CreateTeam

Methods

toJSON :: CreateTeam -> Value

toEncoding :: CreateTeam -> Encoding

toJSONList :: [CreateTeam] -> Value

toEncodingList :: [CreateTeam] -> Encoding

FromJSON CreateTeam

CreateTeam derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser CreateTeam

parseJSONList :: Value -> Parser [CreateTeam]

SparkCreate CreateTeam

User can create a team.

SparkResponse CreateTeam

Create team API uses "CreateTeam' and responses Team.

Associated Types

type ToResponse CreateTeam :: *

SparkApiPath CreateTeam

Create team API uses CreateTeam and path "teams".

Methods

apiPath :: CreateTeam -> ByteString

type ToResponse CreateTeam

type ToResponse CreateTeam = Team

newtype UpdateTeam

UpdateTeam is encoded to request body JSON of Update a Team REST call.

Constructors

UpdateTeam

Fields

• updateTeamName :: TeamName

Instances

Eq UpdateTeam

Methods

(==) :: UpdateTeam -> UpdateTeam -> Bool

(/=) :: UpdateTeam -> UpdateTeam -> Bool

Show UpdateTeam

Methods

showsPrec :: Int -> UpdateTeam -> ShowS

show :: UpdateTeam -> String

showList :: [UpdateTeam] -> ShowS

ToJSON UpdateTeam

Methods

toJSON :: UpdateTeam -> Value

toEncoding :: UpdateTeam -> Encoding

toJSONList :: [UpdateTeam] -> Value

toEncodingList :: [UpdateTeam] -> Encoding

FromJSON UpdateTeam

UpdateTeam derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser UpdateTeam

parseJSONList :: Value -> Parser [UpdateTeam]

SparkUpdate UpdateTeam

User can update a team.

SparkResponse UpdateTeam

Update team API uses "UpdateTeam' and responses Team.

Associated Types

type ToResponse UpdateTeam :: *

SparkApiPath UpdateTeam

Update team API uses UpdateTeam and path "teams".

Methods

apiPath :: UpdateTeam -> ByteString

type ToResponse UpdateTeam

type ToResponse UpdateTeam = Team

Team Membership related types

data TeamMembership

TeamMembership is association between Team and Person. It can be N:N relation. A Person can belong to multiple Team. TeamMembership is decoded from response JSON of Get Team Membership Details REST call. It is also element type of response of List Team Memberships call.

Constructors

TeamMembership

Fields

• teamMembershipId :: TeamMembershipId

  Identifier of the TeamMembership entry.

• teamMembershipErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• teamMembershipTeamId :: Maybe TeamId

  Identifier of the Team which the Person belongs to.

• teamMembershipPersonId :: Maybe PersonId

  Identifier of user who belongs to the Team.

• teamMembershipPersonEmail :: Maybe Email

  Email address of the user identified by the PersonId.

• teamMembershipPersonDisplayName :: Maybe DisplayName

  Display name of the user identified by the PersonId.

• teamMembershipPersonOrgId :: Maybe OrganizationId

  Identifier of Organization which the Team blongs to.

• teamMembershipIsModerator :: Maybe Bool

  The Person is moderator of the Team when True.

• teamMembershipCreated :: Maybe Timestamp

  Timestamp when the TeamMembership entry created.

Instances

Eq TeamMembership

Methods

(==) :: TeamMembership -> TeamMembership -> Bool

(/=) :: TeamMembership -> TeamMembership -> Bool

Show TeamMembership

Methods

showsPrec :: Int -> TeamMembership -> ShowS

show :: TeamMembership -> String

showList :: [TeamMembership] -> ShowS

ToJSON TeamMembership

Methods

toJSON :: TeamMembership -> Value

toEncoding :: TeamMembership -> Encoding

toJSONList :: [TeamMembership] -> Value

toEncodingList :: [TeamMembership] -> Encoding

FromJSON TeamMembership

TeamMembership derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser TeamMembership

parseJSONList :: Value -> Parser [TeamMembership]

SparkListItem TeamMembership

TeamMembershipList wraps TeamMembership

Associated Types

type ToList TeamMembership :: *

Methods

unwrap :: ToList TeamMembership -> [TeamMembership]

type ToList TeamMembership

type ToList TeamMembership = TeamMembershipList

newtype TeamMembershipId

Identifying TeamMembership.

Constructors

TeamMembershipId Text

Instances

Eq TeamMembershipId

Methods

(==) :: TeamMembershipId -> TeamMembershipId -> Bool

(/=) :: TeamMembershipId -> TeamMembershipId -> Bool

Show TeamMembershipId

Methods

showsPrec :: Int -> TeamMembershipId -> ShowS

show :: TeamMembershipId -> String

showList :: [TeamMembershipId] -> ShowS

Generic TeamMembershipId

Associated Types

type Rep TeamMembershipId :: * -> *

Methods

from :: TeamMembershipId -> Rep TeamMembershipId x

to :: Rep TeamMembershipId x -> TeamMembershipId

ToJSON TeamMembershipId

Methods

toJSON :: TeamMembershipId -> Value

toEncoding :: TeamMembershipId -> Encoding

toJSONList :: [TeamMembershipId] -> Value

toEncodingList :: [TeamMembershipId] -> Encoding

FromJSON TeamMembershipId

Methods

parseJSON :: Value -> Parser TeamMembershipId

parseJSONList :: Value -> Parser [TeamMembershipId]

SparkDetail TeamMembershipId

User can get detail of a team membership.

Methods

toIdStr :: TeamMembershipId -> Text

SparkResponse TeamMembershipId

Get detail for a team membership API uses "TeamMembershipId' and responses TeamMembership.

Associated Types

type ToResponse TeamMembershipId :: *

SparkApiPath TeamMembershipId

Get detail for a team membership API uses TeamMembershipId and path "team/memberships".

Methods

apiPath :: TeamMembershipId -> ByteString

type Rep TeamMembershipId

type Rep TeamMembershipId = D1 * (MetaData "TeamMembershipId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "TeamMembershipId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse TeamMembershipId

type ToResponse TeamMembershipId = TeamMembership

newtype TeamMembershipList

TeamMembershipList is decoded from response JSON of List Team Memberships REST call. It is list of TeamMembership.

Constructors

TeamMembershipList

Fields

• teamMembershipListItems :: [TeamMembership]

Instances

Eq TeamMembershipList

Methods

(==) :: TeamMembershipList -> TeamMembershipList -> Bool

(/=) :: TeamMembershipList -> TeamMembershipList -> Bool

Show TeamMembershipList

Methods

showsPrec :: Int -> TeamMembershipList -> ShowS

show :: TeamMembershipList -> String

showList :: [TeamMembershipList] -> ShowS

ToJSON TeamMembershipList

Methods

toJSON :: TeamMembershipList -> Value

toEncoding :: TeamMembershipList -> Encoding

toJSONList :: [TeamMembershipList] -> Value

toEncodingList :: [TeamMembershipList] -> Encoding

FromJSON TeamMembershipList

TeamMembershipList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser TeamMembershipList

parseJSONList :: Value -> Parser [TeamMembershipList]

newtype TeamMembershipFilter

Optional query strings for team membership list API

Constructors

TeamMembershipFilter

Fields

• teamMembershipFilterTeamId :: TeamId

  List membership only in given team.

Instances

Eq TeamMembershipFilter

Methods

(==) :: TeamMembershipFilter -> TeamMembershipFilter -> Bool

(/=) :: TeamMembershipFilter -> TeamMembershipFilter -> Bool

Show TeamMembershipFilter

Methods

showsPrec :: Int -> TeamMembershipFilter -> ShowS

show :: TeamMembershipFilter -> String

showList :: [TeamMembershipFilter] -> ShowS

SparkFilter TeamMembershipFilter

User can list team membership with filter parameter.

Methods

toFilterList :: TeamMembershipFilter -> [(ByteString, Maybe ByteString)]

SparkResponse TeamMembershipFilter

List team memberships API uses TeamMembershipFilter and responses TeamMembership.

Associated Types

type ToResponse TeamMembershipFilter :: *

SparkApiPath TeamMembershipFilter

List team memberships API uses TeamMembershipFilter and path "team/memberships".

Methods

apiPath :: TeamMembershipFilter -> ByteString

type ToResponse TeamMembershipFilter

type ToResponse TeamMembershipFilter = TeamMembership

data CreateTeamMembership

CreateTeamMembership is encoded to request body JSON of Create a Team Membership REST call.

Constructors

CreateTeamMembership

Fields

• createTeamMembershipTeamId :: TeamId

  Identifier of Team which the user will be added to.

• createTeamMembershipPersonId :: Maybe PersonId

  Identifier of Person who will be added to the Team.

• createTeamMembershipPersonEmail :: Maybe Email

  Email of the Person to be added.

• createTeamMembershipIsModerator :: Maybe Bool

  The user becomes a moderator of the team if True.

Instances

Eq CreateTeamMembership

Methods

(==) :: CreateTeamMembership -> CreateTeamMembership -> Bool

(/=) :: CreateTeamMembership -> CreateTeamMembership -> Bool

Show CreateTeamMembership

Methods

showsPrec :: Int -> CreateTeamMembership -> ShowS

show :: CreateTeamMembership -> String

showList :: [CreateTeamMembership] -> ShowS

ToJSON CreateTeamMembership

Methods

toJSON :: CreateTeamMembership -> Value

toEncoding :: CreateTeamMembership -> Encoding

toJSONList :: [CreateTeamMembership] -> Value

toEncodingList :: [CreateTeamMembership] -> Encoding

FromJSON CreateTeamMembership

CreateTeamMembership derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser CreateTeamMembership

parseJSONList :: Value -> Parser [CreateTeamMembership]

SparkCreate CreateTeamMembership

User can create a teamMembership.

SparkResponse CreateTeamMembership

Create teamMembership API uses "CreateTeamMembership' and responses TeamMembership.

Associated Types

type ToResponse CreateTeamMembership :: *

SparkApiPath CreateTeamMembership

Create teamMembership API uses CreateTeamMembership and path "team/memberships".

Methods

apiPath :: CreateTeamMembership -> ByteString

type ToResponse CreateTeamMembership

type ToResponse CreateTeamMembership = TeamMembership

newtype UpdateTeamMembership

UpdateTeamMembership is encoded to request body JSON of Update a Team Membership REST call.

Constructors

UpdateTeamMembership

Fields

• updateTeamMembershipIsModerator :: Bool

Instances

Eq UpdateTeamMembership

Methods

(==) :: UpdateTeamMembership -> UpdateTeamMembership -> Bool

(/=) :: UpdateTeamMembership -> UpdateTeamMembership -> Bool

Show UpdateTeamMembership

Methods

showsPrec :: Int -> UpdateTeamMembership -> ShowS

show :: UpdateTeamMembership -> String

showList :: [UpdateTeamMembership] -> ShowS

ToJSON UpdateTeamMembership

Methods

toJSON :: UpdateTeamMembership -> Value

toEncoding :: UpdateTeamMembership -> Encoding

toJSONList :: [UpdateTeamMembership] -> Value

toEncodingList :: [UpdateTeamMembership] -> Encoding

FromJSON UpdateTeamMembership

UpdateTeamMembership derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser UpdateTeamMembership

parseJSONList :: Value -> Parser [UpdateTeamMembership]

SparkUpdate UpdateTeamMembership

User can update a teamMembership.

SparkResponse UpdateTeamMembership

Update teamMembership API uses "UpdateTeamMembership' and responses TeamMembership.

Associated Types

type ToResponse UpdateTeamMembership :: *

SparkApiPath UpdateTeamMembership

Update teamMembership API uses UpdateTeamMembership and path "team/memberships".

Methods

apiPath :: UpdateTeamMembership -> ByteString

type ToResponse UpdateTeamMembership

type ToResponse UpdateTeamMembership = TeamMembership

Organization related types

data Organization

Organization is an administrative group of Cisco Spark users. Each Person belongs to one Organization. Organization is decoded from response JSON of Get Organization Details REST call. It is also element type of response of List Organizations call.

Constructors

Organization

Fields

• organizationId :: OrganizationId

  Identifier of the Organization.

• organizationErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• organizationDisplayName :: Maybe OrganizationDisplayName

  Display name of the Organization.

• organizationCreated :: Maybe Timestamp

  Timestamp when the Organization was created.

Instances

Eq Organization

Methods

(==) :: Organization -> Organization -> Bool

(/=) :: Organization -> Organization -> Bool

Show Organization

Methods

showsPrec :: Int -> Organization -> ShowS

show :: Organization -> String

showList :: [Organization] -> ShowS

ToJSON Organization

Methods

toJSON :: Organization -> Value

toEncoding :: Organization -> Encoding

toJSONList :: [Organization] -> Value

toEncodingList :: [Organization] -> Encoding

FromJSON Organization

Organization derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Organization

parseJSONList :: Value -> Parser [Organization]

SparkListItem Organization

OrganizationList wraps Organization

Associated Types

type ToList Organization :: *

Methods

unwrap :: ToList Organization -> [Organization]

type ToList Organization

type ToList Organization = OrganizationList

newtype OrganizationId

Organization identifier which user or team belongs to.

Constructors

OrganizationId Text

Instances

Eq OrganizationId

Methods

(==) :: OrganizationId -> OrganizationId -> Bool

(/=) :: OrganizationId -> OrganizationId -> Bool

Show OrganizationId

Methods

showsPrec :: Int -> OrganizationId -> ShowS

show :: OrganizationId -> String

showList :: [OrganizationId] -> ShowS

Generic OrganizationId

Associated Types

type Rep OrganizationId :: * -> *

Methods

from :: OrganizationId -> Rep OrganizationId x

to :: Rep OrganizationId x -> OrganizationId

ToJSON OrganizationId

Methods

toJSON :: OrganizationId -> Value

toEncoding :: OrganizationId -> Encoding

toJSONList :: [OrganizationId] -> Value

toEncodingList :: [OrganizationId] -> Encoding

FromJSON OrganizationId

Methods

parseJSON :: Value -> Parser OrganizationId

parseJSONList :: Value -> Parser [OrganizationId]

SparkDetail OrganizationId

User can get detail of a organization.

Methods

toIdStr :: OrganizationId -> Text

SparkResponse OrganizationId

Get detail for a organization API uses "OrganizationId' and responses Organization.

Associated Types

type ToResponse OrganizationId :: *

SparkApiPath OrganizationId

Get detail for organization API uses OrganizationId and path "organizations".

Methods

apiPath :: OrganizationId -> ByteString

type Rep OrganizationId

type Rep OrganizationId = D1 * (MetaData "OrganizationId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "OrganizationId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse OrganizationId

type ToResponse OrganizationId = Organization

newtype OrganizationDisplayName

Display name of Organization

Constructors

OrganizationDisplayName Text

Instances

Eq OrganizationDisplayName

Methods

(==) :: OrganizationDisplayName -> OrganizationDisplayName -> Bool

(/=) :: OrganizationDisplayName -> OrganizationDisplayName -> Bool

Show OrganizationDisplayName

Methods

showsPrec :: Int -> OrganizationDisplayName -> ShowS

show :: OrganizationDisplayName -> String

showList :: [OrganizationDisplayName] -> ShowS

Generic OrganizationDisplayName

Associated Types

type Rep OrganizationDisplayName :: * -> *

Methods

from :: OrganizationDisplayName -> Rep OrganizationDisplayName x

to :: Rep OrganizationDisplayName x -> OrganizationDisplayName

ToJSON OrganizationDisplayName

Methods

toJSON :: OrganizationDisplayName -> Value

toEncoding :: OrganizationDisplayName -> Encoding

toJSONList :: [OrganizationDisplayName] -> Value

toEncodingList :: [OrganizationDisplayName] -> Encoding

FromJSON OrganizationDisplayName

Methods

parseJSON :: Value -> Parser OrganizationDisplayName

parseJSONList :: Value -> Parser [OrganizationDisplayName]

type Rep OrganizationDisplayName

type Rep OrganizationDisplayName = D1 * (MetaData "OrganizationDisplayName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "OrganizationDisplayName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype OrganizationList

OrganizationList is decoded from response JSON of List Organizations REST call. It is list of Organization.

Constructors

OrganizationList

Fields

• organizationListItems :: [Organization]

Instances

Eq OrganizationList

Methods

(==) :: OrganizationList -> OrganizationList -> Bool

(/=) :: OrganizationList -> OrganizationList -> Bool

Show OrganizationList

Methods

showsPrec :: Int -> OrganizationList -> ShowS

show :: OrganizationList -> String

showList :: [OrganizationList] -> ShowS

ToJSON OrganizationList

Methods

toJSON :: OrganizationList -> Value

toEncoding :: OrganizationList -> Encoding

toJSONList :: [OrganizationList] -> Value

toEncodingList :: [OrganizationList] -> Encoding

FromJSON OrganizationList

OrganizationList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser OrganizationList

parseJSONList :: Value -> Parser [OrganizationList]

License related types

data License

License is allowance for features and services of Cisco Spark subscription. License is decoded from response JSON of Get License Details REST call. It is also element type of response of List Licenses call.

Constructors

License

Fields

• licenseId :: LicenseId

  Identifier of the License.

• licenseErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• licenseName :: Maybe LicenseName

  Name of the License.

• licenseTotalUnits :: Maybe LicenseUnit

  Number of granted License.

• licenseConsumedUnits :: Maybe LicenseUnit

  Number of currently consumed License.

Instances

Eq License

Methods

(==) :: License -> License -> Bool

(/=) :: License -> License -> Bool

Show License

Methods

showsPrec :: Int -> License -> ShowS

show :: License -> String

showList :: [License] -> ShowS

ToJSON License

Methods

toJSON :: License -> Value

toEncoding :: License -> Encoding

toJSONList :: [License] -> Value

toEncodingList :: [License] -> Encoding

FromJSON License

License derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser License

parseJSONList :: Value -> Parser [License]

SparkListItem License

LicenseList wraps License

Associated Types

type ToList License :: *

Methods

unwrap :: ToList License -> [License]

type ToList License

type ToList License = LicenseList

newtype LicenseId

License identifier which can be enabled on user. See License too.

Constructors

LicenseId Text

Instances

Eq LicenseId

Methods

(==) :: LicenseId -> LicenseId -> Bool

(/=) :: LicenseId -> LicenseId -> Bool

Show LicenseId

Methods

showsPrec :: Int -> LicenseId -> ShowS

show :: LicenseId -> String

showList :: [LicenseId] -> ShowS

Generic LicenseId

Associated Types

type Rep LicenseId :: * -> *

Methods

from :: LicenseId -> Rep LicenseId x

to :: Rep LicenseId x -> LicenseId

ToJSON LicenseId

Methods

toJSON :: LicenseId -> Value

toEncoding :: LicenseId -> Encoding

toJSONList :: [LicenseId] -> Value

toEncodingList :: [LicenseId] -> Encoding

FromJSON LicenseId

Methods

parseJSON :: Value -> Parser LicenseId

parseJSONList :: Value -> Parser [LicenseId]

SparkDetail LicenseId

User can get detail of a license.

Methods

toIdStr :: LicenseId -> Text

SparkResponse LicenseId

Get detail for a license API uses "LicenseId' and responses License.

Associated Types

type ToResponse LicenseId :: *

SparkApiPath LicenseId

Get detail for license API uses LicenseId and path "licenses".

Methods

apiPath :: LicenseId -> ByteString

type Rep LicenseId

type Rep LicenseId = D1 * (MetaData "LicenseId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "LicenseId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse LicenseId

type ToResponse LicenseId = License

newtype LicenseName

Display name of License

Constructors

LicenseName Text

Instances

Eq LicenseName

Methods

(==) :: LicenseName -> LicenseName -> Bool

(/=) :: LicenseName -> LicenseName -> Bool

Show LicenseName

Methods

showsPrec :: Int -> LicenseName -> ShowS

show :: LicenseName -> String

showList :: [LicenseName] -> ShowS

Generic LicenseName

Associated Types

type Rep LicenseName :: * -> *

Methods

from :: LicenseName -> Rep LicenseName x

to :: Rep LicenseName x -> LicenseName

ToJSON LicenseName

Methods

toJSON :: LicenseName -> Value

toEncoding :: LicenseName -> Encoding

toJSONList :: [LicenseName] -> Value

toEncodingList :: [LicenseName] -> Encoding

FromJSON LicenseName

Methods

parseJSON :: Value -> Parser LicenseName

parseJSONList :: Value -> Parser [LicenseName]

type Rep LicenseName

type Rep LicenseName = D1 * (MetaData "LicenseName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "LicenseName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype LicenseUnit

Counting number of granted or consumed License

Constructors

LicenseUnit Integer

Instances

Eq LicenseUnit

Methods

(==) :: LicenseUnit -> LicenseUnit -> Bool

(/=) :: LicenseUnit -> LicenseUnit -> Bool

Show LicenseUnit

Methods

showsPrec :: Int -> LicenseUnit -> ShowS

show :: LicenseUnit -> String

showList :: [LicenseUnit] -> ShowS

Generic LicenseUnit

Associated Types

type Rep LicenseUnit :: * -> *

Methods

from :: LicenseUnit -> Rep LicenseUnit x

to :: Rep LicenseUnit x -> LicenseUnit

ToJSON LicenseUnit

Methods

toJSON :: LicenseUnit -> Value

toEncoding :: LicenseUnit -> Encoding

toJSONList :: [LicenseUnit] -> Value

toEncodingList :: [LicenseUnit] -> Encoding

FromJSON LicenseUnit

Methods

parseJSON :: Value -> Parser LicenseUnit

parseJSONList :: Value -> Parser [LicenseUnit]

type Rep LicenseUnit

type Rep LicenseUnit = D1 * (MetaData "LicenseUnit" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "LicenseUnit" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Integer)))

newtype LicenseList

LicenseList is decoded from response JSON of List Licenses REST call. It is list of License.

Constructors

LicenseList

Fields

• licenseListItems :: [License]

Instances

Eq LicenseList

Methods

(==) :: LicenseList -> LicenseList -> Bool

(/=) :: LicenseList -> LicenseList -> Bool

Show LicenseList

Methods

showsPrec :: Int -> LicenseList -> ShowS

show :: LicenseList -> String

showList :: [LicenseList] -> ShowS

ToJSON LicenseList

Methods

toJSON :: LicenseList -> Value

toEncoding :: LicenseList -> Encoding

toJSONList :: [LicenseList] -> Value

toEncodingList :: [LicenseList] -> Encoding

FromJSON LicenseList

LicenseList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser LicenseList

parseJSONList :: Value -> Parser [LicenseList]

newtype LicenseFilter

Optional query strings for license list API

Constructors

LicenseFilter

Fields

• licenseFilterOrgId :: Maybe OrganizationId

  List licenses only applicable to given organization.

Instances

Eq LicenseFilter

Methods

(==) :: LicenseFilter -> LicenseFilter -> Bool

(/=) :: LicenseFilter -> LicenseFilter -> Bool

Show LicenseFilter

Methods

showsPrec :: Int -> LicenseFilter -> ShowS

show :: LicenseFilter -> String

showList :: [LicenseFilter] -> ShowS

Generic LicenseFilter

Associated Types

type Rep LicenseFilter :: * -> *

Methods

from :: LicenseFilter -> Rep LicenseFilter x

to :: Rep LicenseFilter x -> LicenseFilter

Default LicenseFilter

Methods

def :: LicenseFilter

SparkFilter LicenseFilter

User can list licenses with filter parameter.

Methods

toFilterList :: LicenseFilter -> [(ByteString, Maybe ByteString)]

SparkResponse LicenseFilter

List licenses API uses LicenseFilter and responses License.

Associated Types

type ToResponse LicenseFilter :: *

SparkApiPath LicenseFilter

List licenses API uses LicenseFilter and path "licenses".

Methods

apiPath :: LicenseFilter -> ByteString

type Rep LicenseFilter

type Rep LicenseFilter = D1 * (MetaData "LicenseFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "LicenseFilter" PrefixI True) (S1 * (MetaSel (Just Symbol "licenseFilterOrgId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe OrganizationId))))

type ToResponse LicenseFilter

type ToResponse LicenseFilter = License

Role related types

data Role

A persona for an authenticated user, corresponding to a set of privileges within an organization. Role is decoded from response JSON of Get Role Details REST call. It is also element type of response of List Roles call.

Constructors

Role

Fields

• roleId :: RoleId

  Identifier of the Role

• roleErrors :: Maybe Errors

  Element level error possibly contained in List API response.

• roleName :: Maybe RoleName

  Name of the Role

Instances

Eq Role

Methods

(==) :: Role -> Role -> Bool

(/=) :: Role -> Role -> Bool

Show Role

Methods

showsPrec :: Int -> Role -> ShowS

show :: Role -> String

showList :: [Role] -> ShowS

ToJSON Role

Methods

toJSON :: Role -> Value

toEncoding :: Role -> Encoding

toJSONList :: [Role] -> Value

toEncodingList :: [Role] -> Encoding

FromJSON Role

Role derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser Role

parseJSONList :: Value -> Parser [Role]

SparkListItem Role

RoleList wraps Role

Associated Types

type ToList Role :: *

Methods

unwrap :: ToList Role -> [Role]

type ToList Role

type ToList Role = RoleList

newtype RoleId

Role identifier which can be assigned to user. See Role too.

Constructors

RoleId Text

Instances

Eq RoleId

Methods

(==) :: RoleId -> RoleId -> Bool

(/=) :: RoleId -> RoleId -> Bool

Show RoleId

Methods

showsPrec :: Int -> RoleId -> ShowS

show :: RoleId -> String

showList :: [RoleId] -> ShowS

Generic RoleId

Associated Types

type Rep RoleId :: * -> *

Methods

from :: RoleId -> Rep RoleId x

to :: Rep RoleId x -> RoleId

ToJSON RoleId

Methods

toJSON :: RoleId -> Value

toEncoding :: RoleId -> Encoding

toJSONList :: [RoleId] -> Value

toEncodingList :: [RoleId] -> Encoding

FromJSON RoleId

Methods

parseJSON :: Value -> Parser RoleId

parseJSONList :: Value -> Parser [RoleId]

SparkDetail RoleId

User can get detail of a role.

Methods

toIdStr :: RoleId -> Text

SparkResponse RoleId

Get detail for a role API uses "RoleId' and responses Role.

Associated Types

type ToResponse RoleId :: *

SparkApiPath RoleId

Get detail for role API uses RoleId and path "roles".

Methods

apiPath :: RoleId -> ByteString

type Rep RoleId

type Rep RoleId = D1 * (MetaData "RoleId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "RoleId" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type ToResponse RoleId

type ToResponse RoleId = Role

newtype RoleName

Name of Role.

Constructors

RoleName Text

Instances

Eq RoleName

Methods

(==) :: RoleName -> RoleName -> Bool

(/=) :: RoleName -> RoleName -> Bool

Show RoleName

Methods

showsPrec :: Int -> RoleName -> ShowS

show :: RoleName -> String

showList :: [RoleName] -> ShowS

Generic RoleName

Associated Types

type Rep RoleName :: * -> *

Methods

from :: RoleName -> Rep RoleName x

to :: Rep RoleName x -> RoleName

ToJSON RoleName

Methods

toJSON :: RoleName -> Value

toEncoding :: RoleName -> Encoding

toJSONList :: [RoleName] -> Value

toEncodingList :: [RoleName] -> Encoding

FromJSON RoleName

Methods

parseJSON :: Value -> Parser RoleName

parseJSONList :: Value -> Parser [RoleName]

type Rep RoleName

type Rep RoleName = D1 * (MetaData "RoleName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.2-4uci0XnKBqiELiRI38tANM" True) (C1 * (MetaCons "RoleName" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

newtype RoleList

RoleList is decoded from response JSON of List Role REST call. It is list of Role.

Constructors

RoleList

Fields

• roleListItems :: [Role]

Instances

Eq RoleList

Methods

(==) :: RoleList -> RoleList -> Bool

(/=) :: RoleList -> RoleList -> Bool

Show RoleList

Methods

showsPrec :: Int -> RoleList -> ShowS

show :: RoleList -> String

showList :: [RoleList] -> ShowS

ToJSON RoleList

Methods

toJSON :: RoleList -> Value

toEncoding :: RoleList -> Encoding

toJSONList :: [RoleList] -> Value

toEncodingList :: [RoleList] -> Encoding

FromJSON RoleList

RoleList derives ToJSON and FromJSON via deriveJSON template haskell function.

Methods

parseJSON :: Value -> Parser RoleList

parseJSONList :: Value -> Parser [RoleList]

Functions

Getting detail of an entity

getDetail

Arguments

:: (MonadIO m, SparkDetail key)

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> key

One of PersonId, RoomId, MembershipId, MessageId, TeamId, TeamMembershipId, OrganizationId, LicenseId and RoleId.

-> m (Response (ToResponse key))

Get details of a Spark entity.

Obtaining detail of an entity identified by key. The key can be a value in one of following types: PersonId, RoomId, MembershipId, MessageId, TeamId, TeamMembershipId, OrganizationId, LicenseId, RoleId. API is automatically selected by type of the key. A JSONException runtime exception will be thrown on an JSON parse errors.

getDetailEither :: (MonadIO m, SparkDetail key) => Authorization -> CiscoSparkRequest -> key -> m (Response (Either JSONException (ToResponse key)))

Get details of a Spark entity. A Left value will be returned on an JSON parse errors.

Streaming response of List API with auto pagenation

streamEntityWithFilter :: (MonadIO m, SparkFilter filter, SparkListItem (ToResponse filter)) => Authorization -> CiscoSparkRequest -> filter -> ConduitT () (ToResponse filter) m ()

Get list of entities with query parameter and stream it into Conduit pipe. It automatically performs pagination.

streamTeamList :: MonadIO m => Authorization -> CiscoSparkRequest -> ConduitT () Team m ()

List of Team and stream it into Conduit pipe. It automatically performs pagination.

streamOrganizationList :: MonadIO m => Authorization -> CiscoSparkRequest -> ConduitT () Organization m ()

Filter list of Organization and stream it into Conduit pipe. It automatically performs pagination.

streamRoleList :: MonadIO m => Authorization -> CiscoSparkRequest -> ConduitT () Role m ()

List of Role and stream it into Conduit pipe. It automatically performs pagination.

Creating an entity

createEntity

Arguments

:: (MonadIO m, SparkCreate createParams)

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> createParams

One of CreatePerson, CreateRoom, CreateMembership, CreateMessage, CreateTeam and CreateTeamMembership.

-> m (Response (ToResponse createParams))

Create a Spark entity with given parameters.

Creating a new entity of Spark such as space, team, membership or message. REST API path is automatically selected by type of createParams. A JSONException runtime exception will be thrown on an JSON parse errors.

createEntityEither :: (MonadIO m, SparkCreate createParams) => Authorization -> CiscoSparkRequest -> createParams -> m (Response (Either JSONException (ToResponse createParams)))

Create a Spark entity with given parameters. A Left value will be returned on an JSON parse errors.

Updating an entity

updateEntity

Arguments

:: (MonadIO m, SparkUpdate updateParams)

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> updateParams

One of UpdatePerson, UpdateRoom, UpdateMembership, UpdateTeam and UpdateTeamMembership.

-> m (Response (ToResponse updateParams))

Update a Spark entity with given parameters.

Creating a new entity of Spark such as space, team, or membership. REST API path is automatically selected by type of updateParams. A JSONException runtime exception will be thrown on an JSON parse errors.

updateEntityEither :: (MonadIO m, SparkUpdate updateParams) => Authorization -> CiscoSparkRequest -> updateParams -> m (Response (Either JSONException (ToResponse updateParams)))

Update a Spark entity with given parameters. A Left value will be returned on an JSON parse errors.

Creating default filter spec from mandatory field

defaultMessageFilter :: RoomId -> MessageFilter

Default value of query strings for message list API. Because RoomId is mandatory, user have to supply it in order to get rest of defaults.

defaultTeamMembershipFilter :: TeamId -> TeamMembershipFilter

Default value of query strings for team membership list API. Because TeamId is mandatory, user have to supply it in order to get rest of defaults. As of writing, there is no filter parameter other than TeamId but TeamMembershipFilter is used for providing consistent API like streamEntityWithFilter.

Deleting an entity

deleteRoom

Arguments

:: MonadIO m

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> RoomId

Identifier of a space to be deleted.

-> m (Response ())

Deletes a room, by ID.

deleteMembership

Arguments

:: MonadIO m

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> MembershipId

Identifier of a space to be deleted.

-> m (Response ())

Deletes a membership, by ID.

deleteMessage

Arguments

:: MonadIO m

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> MessageId

Identifier of a space to be deleted.

-> m (Response ())

Deletes a message, by ID.

deleteTeam

Arguments

:: MonadIO m

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> TeamId

Identifier of a space to be deleted.

-> m (Response ())

Deletes a team, by ID.

deleteTeamMembership

Arguments

:: MonadIO m

=> Authorization

Authorization string against Spark API.

-> CiscoSparkRequest

Predefined part of Request commonly used for Cisco Spark API.

-> TeamMembershipId

Identifier of a space to be deleted.

-> m (Response ())

Deletes a teamMembership, by ID.