Copyright	(c) Naoto Shimazaki 2017
License	MIT (see the file LICENSE)
Maintainer	https://github.com/nshimaza
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Network.CiscoSpark

Contents

Types
Functions

Description

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.

Synopsis

newtype Authorization = Authorization ByteString
data CiscoSparkRequest = CiscoSparkRequest {
- ciscoSparkRequestRequest :: Request
- ciscoSparkRequestScheme :: String
- ciscoSparkRequestAuthority :: URIAuth
}
newtype Timestamp = Timestamp Text
newtype ErrorCode = ErrorCode Text
data ErrorTitle = ErrorTitle {
- errorTitleCode :: ErrorCode
- errorTitleReason :: Text
}
newtype Errors = Errors {
- errorsTitle :: ErrorTitle
}
data Person = Person {
- personId :: PersonId
- personErrors :: Maybe Errors
- personEmails :: Maybe [Email]
- personDisplayName :: Maybe DisplayName
- personNickName :: Maybe NickName
- personFirstName :: Maybe FirstName
- personLastName :: Maybe LastName
- personAvatar :: Maybe AvatarUrl
- personOrgId :: Maybe OrganizationId
- personRoles :: Maybe [RoleId]
- personLicenses :: Maybe [LicenseId]
- personCreated :: Maybe Timestamp
- personTimezone :: Maybe Timezone
- personLastActivity :: Maybe Timestamp
- personStatus :: Maybe PersonStatus
- personInvitePending :: Maybe Bool
- personLoginEnabled :: Maybe Bool
- personType :: Maybe PersonType
}
newtype PersonId = PersonId Text
newtype Email = Email Text
newtype DisplayName = DisplayName Text
newtype NickName = NickName Text
newtype FirstName = FirstName Text
newtype LastName = LastName Text
newtype AvatarUrl = AvatarUrl Text
newtype Timezone = Timezone Text
data PersonStatus
- = PersonStatusActive
- | PersonStatusInactive
- | PersonStatusOutOfOffice
- | PersonStatusDoNotDisturb
- | PersonStatusUnknown
data PersonType
- = PersonTypePerson
- | PersonTypeBot
newtype PersonList = PersonList {
- personListItems :: [Person]
}
data PersonFilter = PersonFilter {
- personFilterEmail :: Maybe Email
- personFilterDisplayName :: Maybe DisplayName
- personFilterOrgId :: Maybe OrganizationId
}
data CreatePerson = CreatePerson {
- createPersonEmails :: Maybe [Email]
- createPersonDisplayName :: Maybe DisplayName
- createPersonFirstName :: Maybe FirstName
- createPersonLastName :: Maybe LastName
- createPersonAvatar :: Maybe AvatarUrl
- createPersonOrgId :: Maybe OrganizationId
- createPersonRoles :: Maybe [RoleId]
- createPersonLicenses :: Maybe [LicenseId]
}
data UpdatePerson = UpdatePerson {
- updatePersonDisplayName :: Maybe DisplayName
- updatePersonFirstName :: Maybe FirstName
- updatePersonLastName :: Maybe LastName
- updatePersonAvatar :: Maybe AvatarUrl
- updatePersonOrgId :: Maybe OrganizationId
- updatePersonRoles :: Maybe [RoleId]
- updatePersonLicenses :: Maybe [LicenseId]
}
data Room = Room {
- roomId :: RoomId
- roomErrors :: Maybe Errors
- roomTitle :: Maybe RoomTitle
- roomType :: Maybe RoomType
- roomIsLocked :: Maybe Bool
- roomSipAddress :: Maybe SipAddr
- roomLastActivity :: Maybe Timestamp
- roomTeamId :: Maybe TeamId
- roomCreatorId :: Maybe PersonId
- roomCreated :: Maybe Timestamp
}
newtype RoomId = RoomId Text
newtype RoomTitle = RoomTitle Text
data RoomType
- = RoomTypeDirect
- | RoomTypeGroup
newtype SipAddr = SipAddr Text
newtype RoomList = RoomList {
- roomListItems :: [Room]
}
data RoomFilter = RoomFilter {
- roomFilterTeamId :: Maybe TeamId
- roomFilterRoomType :: Maybe RoomType
- roomFilterSortBy :: Maybe RoomFilterSortBy
}
data RoomFilterSortBy
- = RoomFilterSortById
- | RoomFilterSortByLastActivity
- | RoomFilterSortByCreated
data CreateRoom = CreateRoom {
- createRoomTitle :: RoomTitle
- createRoomTeamId :: Maybe TeamId
}
newtype UpdateRoom = UpdateRoom {
- updateRoomTitle :: RoomTitle
}
data Membership = Membership {
- membershipId :: MembershipId
- membershipErrors :: Maybe Errors
- membershipRoomId :: Maybe RoomId
- membershipPersonId :: Maybe PersonId
- membershipPersonEmail :: Maybe Email
- membershipPersonDisplayName :: Maybe DisplayName
- membershipPersonOrgId :: Maybe OrganizationId
- membershipIsModerator :: Maybe Bool
- membershipIsMonitor :: Maybe Bool
- membershipCreated :: Maybe Timestamp
}
newtype MembershipId = MembershipId Text
newtype MembershipList = MembershipList {
- membershipListItems :: [Membership]
}
data MembershipFilter = MembershipFilter {
- membershipFilterRoomId :: Maybe RoomId
- membershipFilterPersonId :: Maybe PersonId
- membershipFilterPersonEmail :: Maybe Email
}
data CreateMembership = CreateMembership {
- createMembershipRoomId :: RoomId
- createMembershipPersonId :: Maybe PersonId
- createMembershipPersonEmail :: Maybe Email
- createMembershipIsModerator :: Maybe Bool
}
newtype UpdateMembership = UpdateMembership {
- updateMembershipIsModerator :: Bool
}
data Message = Message {
- messageId :: MessageId
- messageErrors :: Maybe Errors
- messageRoomId :: Maybe RoomId
- messageRoomType :: Maybe RoomType
- messageToPersonId :: Maybe PersonId
- messageToPersonEmail :: Maybe Email
- messageText :: Maybe MessageText
- messageHtml :: Maybe MessageHtml
- messageFiles :: Maybe [FileUrl]
- messagePersonId :: Maybe PersonId
- messagePersonEmail :: Maybe Email
- messageCreated :: Maybe Timestamp
- messageMentionedPeople :: Maybe [PersonId]
}
newtype MessageId = MessageId Text
newtype MessageText = MessageText Text
newtype MessageHtml = MessageHtml Text
newtype MessageMarkdown = MessageMarkdown Text
newtype FileUrl = FileUrl Text
newtype MessageList = MessageList {
- messageListItems :: [Message]
}
data MessageFilter = MessageFilter {
- messageFilterRoomId :: RoomId
- messageFilterMentionedPeople :: Maybe MentionedPeople
- messageFilterBefore :: Maybe Timestamp
- messageFilterBeforeMessage :: Maybe MessageId
}
data MentionedPeople
- = MentionedPeopleMe
- | MentionedPeople PersonId
data CreateMessage = CreateMessage {
- createMessageRoomId :: Maybe RoomId
- createMessageToPersonId :: Maybe PersonId
- createMessageToPersonEmail :: Maybe Email
- createMessageText :: Maybe MessageText
- createMessageMarkdown :: Maybe MessageMarkdown
- createMessageFiles :: Maybe [FileUrl]
}
newtype TeamName = TeamName Text
newtype TeamId = TeamId Text
data Team = Team {
- teamId :: TeamId
- teamErrors :: Maybe Errors
- teamName :: Maybe TeamName
- teamCreatorId :: Maybe PersonId
- teamCreated :: Maybe Timestamp
}
newtype TeamList = TeamList {
- teamListItems :: [Team]
}
newtype CreateTeam = CreateTeam {
- createTeamName :: TeamName
}
newtype UpdateTeam = UpdateTeam {
- updateTeamName :: TeamName
}
data TeamMembership = TeamMembership {
- teamMembershipId :: TeamMembershipId
- teamMembershipErrors :: Maybe Errors
- teamMembershipTeamId :: Maybe TeamId
- teamMembershipPersonId :: Maybe PersonId
- teamMembershipPersonEmail :: Maybe Email
- teamMembershipPersonDisplayName :: Maybe DisplayName
- teamMembershipPersonOrgId :: Maybe OrganizationId
- teamMembershipIsModerator :: Maybe Bool
- teamMembershipCreated :: Maybe Timestamp
}
newtype TeamMembershipId = TeamMembershipId Text
newtype TeamMembershipList = TeamMembershipList {
- teamMembershipListItems :: [TeamMembership]
}
newtype TeamMembershipFilter = TeamMembershipFilter {
- teamMembershipFilterTeamId :: TeamId
}
data CreateTeamMembership = CreateTeamMembership {
- createTeamMembershipTeamId :: TeamId
- createTeamMembershipPersonId :: Maybe PersonId
- createTeamMembershipPersonEmail :: Maybe Email
- createTeamMembershipIsModerator :: Maybe Bool
}
newtype UpdateTeamMembership = UpdateTeamMembership {
- updateTeamMembershipIsModerator :: Bool
}
data Organization = Organization {
- organizationId :: OrganizationId
- organizationErrors :: Maybe Errors
- organizationDisplayName :: Maybe OrganizationDisplayName
- organizationCreated :: Maybe Timestamp
}
newtype OrganizationId = OrganizationId Text
newtype OrganizationDisplayName = OrganizationDisplayName Text
newtype OrganizationList = OrganizationList {
- organizationListItems :: [Organization]
}
data License = License {
- licenseId :: LicenseId
- licenseErrors :: Maybe Errors
- licenseName :: Maybe LicenseName
- licenseTotalUnits :: Maybe LicenseUnit
- licenseConsumedUnits :: Maybe LicenseUnit
}
newtype LicenseId = LicenseId Text
newtype LicenseName = LicenseName Text
newtype LicenseUnit = LicenseUnit Integer
newtype LicenseList = LicenseList {
- licenseListItems :: [License]
}
newtype LicenseFilter = LicenseFilter {
- licenseFilterOrgId :: Maybe OrganizationId
}
data Role = Role {
- roleId :: RoleId
- roleErrors :: Maybe Errors
- roleName :: Maybe RoleName
}
newtype RoleId = RoleId Text
newtype RoleName = RoleName Text
newtype RoleList = RoleList {
- roleListItems :: [Role]
}
getDetail :: (MonadIO m, SparkDetail key) => Authorization -> CiscoSparkRequest -> key -> m (Response (ToResponse key))
getDetailEither :: (MonadIO m, SparkDetail key) => Authorization -> CiscoSparkRequest -> key -> m (Response (Either JSONException (ToResponse key)))
streamEntityWithFilter :: (MonadIO m, SparkFilter filter, SparkListItem (ToResponse filter)) => Authorization -> CiscoSparkRequest -> filter -> ConduitT () (ToResponse filter) m ()
streamTeamList :: MonadIO m => Authorization -> CiscoSparkRequest -> ConduitT () Team m ()
streamOrganizationList :: MonadIO m => Authorization -> CiscoSparkRequest -> ConduitT () Organization m ()
streamRoleList :: MonadIO m => Authorization -> CiscoSparkRequest -> ConduitT () Role m ()
createEntity :: (MonadIO m, SparkCreate createParams) => Authorization -> CiscoSparkRequest -> createParams -> m (Response (ToResponse createParams))
createEntityEither :: (MonadIO m, SparkCreate createParams) => Authorization -> CiscoSparkRequest -> createParams -> m (Response (Either JSONException (ToResponse createParams)))
updateEntity :: (MonadIO m, SparkUpdate updateParams) => Authorization -> CiscoSparkRequest -> updateParams -> m (Response (ToResponse updateParams))
updateEntityEither :: (MonadIO m, SparkUpdate updateParams) => Authorization -> CiscoSparkRequest -> updateParams -> m (Response (Either JSONException (ToResponse updateParams)))
defaultMessageFilter :: RoomId -> MessageFilter
defaultTeamMembershipFilter :: TeamId -> TeamMembershipFilter
deleteRoom :: MonadIO m => Authorization -> CiscoSparkRequest -> RoomId -> m (Response ())
deleteMembership :: MonadIO m => Authorization -> CiscoSparkRequest -> MembershipId -> m (Response ())
deleteMessage :: MonadIO m => Authorization -> CiscoSparkRequest -> MessageId -> m (Response ())
deleteTeam :: MonadIO m => Authorization -> CiscoSparkRequest -> TeamId -> m (Response ())
deleteTeamMembership :: MonadIO m => Authorization -> CiscoSparkRequest -> TeamMembershipId -> m (Response ())

Types

Common Types

newtype Authorization Source #

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

Constructors

Authorization ByteString

Instances

Eq Authorization Source #
Instance details Defined in Network.CiscoSpark Methods (==) :: Authorization -> Authorization -> Bool # (/=) :: Authorization -> Authorization -> Bool #
Show Authorization Source #
Instance details Defined in Network.CiscoSpark Methods showsPrec :: Int -> Authorization -> ShowS # show :: Authorization -> String # showList :: [Authorization] -> ShowS #

data CiscoSparkRequest Source #

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 Source #
Instance details Defined in Network.CiscoSpark Methods showsPrec :: Int -> CiscoSparkRequest -> ShowS # show :: CiscoSparkRequest -> String # showList :: [CiscoSparkRequest] -> ShowS #
Default CiscoSparkRequest Source #	Default parameters for HTTP request to Cisco Spark REST API.
Instance details Defined in Network.CiscoSpark Methods def :: CiscoSparkRequest #

newtype Timestamp Source #

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

Constructors

Timestamp Text

Instances

Eq Timestamp Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Timestamp -> Timestamp -> Bool # (/=) :: Timestamp -> Timestamp -> Bool #
Show Timestamp Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Timestamp -> ShowS # show :: Timestamp -> String # showList :: [Timestamp] -> ShowS #
Generic Timestamp Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep Timestamp :: Type -> Type # Methods from :: Timestamp -> Rep Timestamp x # to :: Rep Timestamp x -> Timestamp #
ToJSON Timestamp Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Timestamp -> Value # toEncoding :: Timestamp -> Encoding # toJSONList :: [Timestamp] -> Value # toEncodingList :: [Timestamp] -> Encoding #
FromJSON Timestamp Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Timestamp # parseJSONList :: Value -> Parser [Timestamp] #
type Rep Timestamp Source #
Instance details Defined in Network.CiscoSpark.Types type Rep Timestamp = D1 (MetaData "Timestamp" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "Timestamp" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ErrorCode Source #

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

Constructors

ErrorCode Text

Instances

Eq ErrorCode Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: ErrorCode -> ErrorCode -> Bool # (/=) :: ErrorCode -> ErrorCode -> Bool #
Show ErrorCode Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> ErrorCode -> ShowS # show :: ErrorCode -> String # showList :: [ErrorCode] -> ShowS #
Generic ErrorCode Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep ErrorCode :: Type -> Type # Methods from :: ErrorCode -> Rep ErrorCode x # to :: Rep ErrorCode x -> ErrorCode #
ToJSON ErrorCode Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: ErrorCode -> Value # toEncoding :: ErrorCode -> Encoding # toJSONList :: [ErrorCode] -> Value # toEncodingList :: [ErrorCode] -> Encoding #
FromJSON ErrorCode Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser ErrorCode # parseJSONList :: Value -> Parser [ErrorCode] #
type Rep ErrorCode Source #
Instance details Defined in Network.CiscoSpark.Types type Rep ErrorCode = D1 (MetaData "ErrorCode" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "ErrorCode" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data ErrorTitle Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: ErrorTitle -> ErrorTitle -> Bool # (/=) :: ErrorTitle -> ErrorTitle -> Bool #
Show ErrorTitle Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> ErrorTitle -> ShowS # show :: ErrorTitle -> String # showList :: [ErrorTitle] -> ShowS #
ToJSON ErrorTitle Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: ErrorTitle -> Value # toEncoding :: ErrorTitle -> Encoding # toJSONList :: [ErrorTitle] -> Value # toEncodingList :: [ErrorTitle] -> Encoding #
FromJSON ErrorTitle Source #	`ErrorTitle` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser ErrorTitle # parseJSONList :: Value -> Parser [ErrorTitle] #

newtype Errors Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Errors -> Errors -> Bool # (/=) :: Errors -> Errors -> Bool #
Show Errors Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Errors -> ShowS # show :: Errors -> String # showList :: [Errors] -> ShowS #
ToJSON Errors Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Errors -> Value # toEncoding :: Errors -> Encoding # toJSONList :: [Errors] -> Value # toEncodingList :: [Errors] -> Encoding #
FromJSON Errors Source #	`Errors` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Errors # parseJSONList :: Value -> Parser [Errors] #

People related types

data Person Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Person -> Person -> Bool # (/=) :: Person -> Person -> Bool #
Show Person Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Person -> ShowS # show :: Person -> String # showList :: [Person] -> ShowS #
ToJSON Person Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Person -> Value # toEncoding :: Person -> Encoding # toJSONList :: [Person] -> Value # toEncodingList :: [Person] -> Encoding #
FromJSON Person Source #	`Person` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Person # parseJSONList :: Value -> Parser [Person] #
SparkListItem Person Source #	`PersonList` wraps `Person`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList Person :: Type Source # Methods unwrap :: ToList Person -> [Person] Source #
type ToList Person Source #
Instance details Defined in Network.CiscoSpark.Types type ToList Person = PersonList

newtype PersonId Source #

Identifying Person describing detail of Cisco Spark user or bot.

Constructors

PersonId Text

Instances

Eq PersonId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: PersonId -> PersonId -> Bool # (/=) :: PersonId -> PersonId -> Bool #
Show PersonId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> PersonId -> ShowS # show :: PersonId -> String # showList :: [PersonId] -> ShowS #
Generic PersonId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep PersonId :: Type -> Type # Methods from :: PersonId -> Rep PersonId x # to :: Rep PersonId x -> PersonId #
ToJSON PersonId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: PersonId -> Value # toEncoding :: PersonId -> Encoding # toJSONList :: [PersonId] -> Value # toEncodingList :: [PersonId] -> Encoding #
FromJSON PersonId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser PersonId # parseJSONList :: Value -> Parser [PersonId] #
SparkDetail PersonId Source #	User can get detail of a person.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: PersonId -> Text Source #
SparkResponse PersonId Source #	Get detail for a person API uses "PersonId' and responses `Person`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse PersonId :: Type Source #
SparkApiPath PersonId Source #	Get detail for a person API uses `PersonId` and path "people".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: PersonId -> ByteString Source #
type Rep PersonId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep PersonId = D1 (MetaData "PersonId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "PersonId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse PersonId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse PersonId = Person

newtype Email Source #

Email address of user.

Constructors

Email Text

Instances

Eq Email Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Email -> Email -> Bool # (/=) :: Email -> Email -> Bool #
Show Email Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Email -> ShowS # show :: Email -> String # showList :: [Email] -> ShowS #
Generic Email Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep Email :: Type -> Type # Methods from :: Email -> Rep Email x # to :: Rep Email x -> Email #
ToJSON Email Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Email -> Value # toEncoding :: Email -> Encoding # toJSONList :: [Email] -> Value # toEncodingList :: [Email] -> Encoding #
FromJSON Email Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Email # parseJSONList :: Value -> Parser [Email] #
type Rep Email Source #
Instance details Defined in Network.CiscoSpark.Types type Rep Email = D1 (MetaData "Email" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "Email" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype DisplayName Source #

Display name of user.

Constructors

DisplayName Text

Instances

Eq DisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: DisplayName -> DisplayName -> Bool # (/=) :: DisplayName -> DisplayName -> Bool #
Show DisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> DisplayName -> ShowS # show :: DisplayName -> String # showList :: [DisplayName] -> ShowS #
Generic DisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep DisplayName :: Type -> Type # Methods from :: DisplayName -> Rep DisplayName x # to :: Rep DisplayName x -> DisplayName #
ToJSON DisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: DisplayName -> Value # toEncoding :: DisplayName -> Encoding # toJSONList :: [DisplayName] -> Value # toEncodingList :: [DisplayName] -> Encoding #
FromJSON DisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser DisplayName # parseJSONList :: Value -> Parser [DisplayName] #
type Rep DisplayName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep DisplayName = D1 (MetaData "DisplayName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "DisplayName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype NickName Source #

Nickname of user.

Constructors

NickName Text

Instances

Eq NickName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: NickName -> NickName -> Bool # (/=) :: NickName -> NickName -> Bool #
Show NickName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> NickName -> ShowS # show :: NickName -> String # showList :: [NickName] -> ShowS #
Generic NickName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep NickName :: Type -> Type # Methods from :: NickName -> Rep NickName x # to :: Rep NickName x -> NickName #
ToJSON NickName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: NickName -> Value # toEncoding :: NickName -> Encoding # toJSONList :: [NickName] -> Value # toEncodingList :: [NickName] -> Encoding #
FromJSON NickName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser NickName # parseJSONList :: Value -> Parser [NickName] #
type Rep NickName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep NickName = D1 (MetaData "NickName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "NickName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype FirstName Source #

First name of user.

Constructors

FirstName Text

Instances

Eq FirstName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: FirstName -> FirstName -> Bool # (/=) :: FirstName -> FirstName -> Bool #
Show FirstName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> FirstName -> ShowS # show :: FirstName -> String # showList :: [FirstName] -> ShowS #
Generic FirstName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep FirstName :: Type -> Type # Methods from :: FirstName -> Rep FirstName x # to :: Rep FirstName x -> FirstName #
ToJSON FirstName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: FirstName -> Value # toEncoding :: FirstName -> Encoding # toJSONList :: [FirstName] -> Value # toEncodingList :: [FirstName] -> Encoding #
FromJSON FirstName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser FirstName # parseJSONList :: Value -> Parser [FirstName] #
type Rep FirstName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep FirstName = D1 (MetaData "FirstName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "FirstName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype LastName Source #

Last name of user.

Constructors

LastName Text

Instances

Eq LastName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: LastName -> LastName -> Bool # (/=) :: LastName -> LastName -> Bool #
Show LastName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> LastName -> ShowS # show :: LastName -> String # showList :: [LastName] -> ShowS #
Generic LastName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep LastName :: Type -> Type # Methods from :: LastName -> Rep LastName x # to :: Rep LastName x -> LastName #
ToJSON LastName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: LastName -> Value # toEncoding :: LastName -> Encoding # toJSONList :: [LastName] -> Value # toEncodingList :: [LastName] -> Encoding #
FromJSON LastName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser LastName # parseJSONList :: Value -> Parser [LastName] #
type Rep LastName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep LastName = D1 (MetaData "LastName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "LastName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype AvatarUrl Source #

URL pointing to image file of Avatar.

Constructors

AvatarUrl Text

Instances

Eq AvatarUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: AvatarUrl -> AvatarUrl -> Bool # (/=) :: AvatarUrl -> AvatarUrl -> Bool #
Show AvatarUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> AvatarUrl -> ShowS # show :: AvatarUrl -> String # showList :: [AvatarUrl] -> ShowS #
Generic AvatarUrl Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep AvatarUrl :: Type -> Type # Methods from :: AvatarUrl -> Rep AvatarUrl x # to :: Rep AvatarUrl x -> AvatarUrl #
ToJSON AvatarUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: AvatarUrl -> Value # toEncoding :: AvatarUrl -> Encoding # toJSONList :: [AvatarUrl] -> Value # toEncodingList :: [AvatarUrl] -> Encoding #
FromJSON AvatarUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser AvatarUrl # parseJSONList :: Value -> Parser [AvatarUrl] #
type Rep AvatarUrl Source #
Instance details Defined in Network.CiscoSpark.Types type Rep AvatarUrl = D1 (MetaData "AvatarUrl" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "AvatarUrl" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype Timezone Source #

Timezone in timezone name.

Constructors

Timezone Text

Instances

Eq Timezone Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Timezone -> Timezone -> Bool # (/=) :: Timezone -> Timezone -> Bool #
Show Timezone Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Timezone -> ShowS # show :: Timezone -> String # showList :: [Timezone] -> ShowS #
Generic Timezone Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep Timezone :: Type -> Type # Methods from :: Timezone -> Rep Timezone x # to :: Rep Timezone x -> Timezone #
ToJSON Timezone Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Timezone -> Value # toEncoding :: Timezone -> Encoding # toJSONList :: [Timezone] -> Value # toEncodingList :: [Timezone] -> Encoding #
FromJSON Timezone Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Timezone # parseJSONList :: Value -> Parser [Timezone] #
type Rep Timezone Source #
Instance details Defined in Network.CiscoSpark.Types type Rep Timezone = D1 (MetaData "Timezone" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "Timezone" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data PersonStatus Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: PersonStatus -> PersonStatus -> Bool # (/=) :: PersonStatus -> PersonStatus -> Bool #
Show PersonStatus Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> PersonStatus -> ShowS # show :: PersonStatus -> String # showList :: [PersonStatus] -> ShowS #
Generic PersonStatus Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep PersonStatus :: Type -> Type # Methods from :: PersonStatus -> Rep PersonStatus x # to :: Rep PersonStatus x -> PersonStatus #
ToJSON PersonStatus Source #	`PersonStatus` implements `toEncoding` to encode each constructor into JSON enum value.
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: PersonStatus -> Value # toEncoding :: PersonStatus -> Encoding # toJSONList :: [PersonStatus] -> Value # toEncodingList :: [PersonStatus] -> Encoding #
FromJSON PersonStatus Source #	`PersonStatus` implements `parseJSON` to decode JSON enum value to a constructor.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser PersonStatus # parseJSONList :: Value -> Parser [PersonStatus] #
type Rep PersonStatus Source #
Instance details Defined in Network.CiscoSpark.Types type Rep PersonStatus = D1 (MetaData "PersonStatus" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" False) ((C1 (MetaCons "PersonStatusActive" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "PersonStatusInactive" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "PersonStatusOutOfOffice" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "PersonStatusDoNotDisturb" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "PersonStatusUnknown" PrefixI False) (U1 :: Type -> Type))))

data PersonType Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: PersonType -> PersonType -> Bool # (/=) :: PersonType -> PersonType -> Bool #
Show PersonType Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> PersonType -> ShowS # show :: PersonType -> String # showList :: [PersonType] -> ShowS #
ToJSON PersonType Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: PersonType -> Value # toEncoding :: PersonType -> Encoding # toJSONList :: [PersonType] -> Value # toEncodingList :: [PersonType] -> Encoding #
FromJSON PersonType Source #	`PersonType` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser PersonType # parseJSONList :: Value -> Parser [PersonType] #

newtype PersonList Source #

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

Constructors

PersonList
Fields personListItems :: [Person]

Instances

Eq PersonList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: PersonList -> PersonList -> Bool # (/=) :: PersonList -> PersonList -> Bool #
Show PersonList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> PersonList -> ShowS # show :: PersonList -> String # showList :: [PersonList] -> ShowS #
ToJSON PersonList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: PersonList -> Value # toEncoding :: PersonList -> Encoding # toJSONList :: [PersonList] -> Value # toEncodingList :: [PersonList] -> Encoding #
FromJSON PersonList Source #	`PersonList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser PersonList # parseJSONList :: Value -> Parser [PersonList] #

data PersonFilter Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: PersonFilter -> PersonFilter -> Bool # (/=) :: PersonFilter -> PersonFilter -> Bool #
Show PersonFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> PersonFilter -> ShowS # show :: PersonFilter -> String # showList :: [PersonFilter] -> ShowS #
Generic PersonFilter Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep PersonFilter :: Type -> Type # Methods from :: PersonFilter -> Rep PersonFilter x # to :: Rep PersonFilter x -> PersonFilter #
Default PersonFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods def :: PersonFilter #
SparkFilter PersonFilter Source #	User can list people with filter parameter.
Instance details Defined in Network.CiscoSpark.Types Methods toFilterList :: PersonFilter -> [(ByteString, Maybe ByteString)] Source #
SparkResponse PersonFilter Source #	List people API uses `PersonFilter` and responses `Person`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse PersonFilter :: Type Source #
SparkApiPath PersonFilter Source #	List people API uses `PersonFilter` and path "people".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: PersonFilter -> ByteString Source #
type Rep PersonFilter Source #
Instance details Defined in Network.CiscoSpark.Types type Rep PersonFilter = D1 (MetaData "PersonFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" False) (C1 (MetaCons "PersonFilter" PrefixI True) (S1 (MetaSel (Just "personFilterEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Email)) :: (S1 (MetaSel (Just "personFilterDisplayName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe DisplayName)) :: S1 (MetaSel (Just "personFilterOrgId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OrganizationId)))))
type ToResponse PersonFilter Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse PersonFilter = Person

data CreatePerson Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: CreatePerson -> CreatePerson -> Bool # (/=) :: CreatePerson -> CreatePerson -> Bool #
Show CreatePerson Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> CreatePerson -> ShowS # show :: CreatePerson -> String # showList :: [CreatePerson] -> ShowS #
ToJSON CreatePerson Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: CreatePerson -> Value # toEncoding :: CreatePerson -> Encoding # toJSONList :: [CreatePerson] -> Value # toEncodingList :: [CreatePerson] -> Encoding #
FromJSON CreatePerson Source #	`CreatePerson` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser CreatePerson # parseJSONList :: Value -> Parser [CreatePerson] #
SparkCreate CreatePerson Source #	User can create a person.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse CreatePerson Source #	Create person API uses "CreatePerson' and responses `Person`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse CreatePerson :: Type Source #
SparkApiPath CreatePerson Source #	Create person API uses `CreatePerson` and path "people".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: CreatePerson -> ByteString Source #
type ToResponse CreatePerson Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse CreatePerson = Person

data UpdatePerson Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: UpdatePerson -> UpdatePerson -> Bool # (/=) :: UpdatePerson -> UpdatePerson -> Bool #
Show UpdatePerson Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> UpdatePerson -> ShowS # show :: UpdatePerson -> String # showList :: [UpdatePerson] -> ShowS #
ToJSON UpdatePerson Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: UpdatePerson -> Value # toEncoding :: UpdatePerson -> Encoding # toJSONList :: [UpdatePerson] -> Value # toEncodingList :: [UpdatePerson] -> Encoding #
FromJSON UpdatePerson Source #	`UpdatePerson` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser UpdatePerson # parseJSONList :: Value -> Parser [UpdatePerson] #
SparkUpdate UpdatePerson Source #	User can update a person.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse UpdatePerson Source #	Update person API uses "UpdatePerson' and responses `Person`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse UpdatePerson :: Type Source #
SparkApiPath UpdatePerson Source #	Update person API uses `UpdatePerson` and path "people".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: UpdatePerson -> ByteString Source #
type ToResponse UpdatePerson Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse UpdatePerson = Person

Room related types

data Room Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Room -> Room -> Bool # (/=) :: Room -> Room -> Bool #
Show Room Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Room -> ShowS # show :: Room -> String # showList :: [Room] -> ShowS #
ToJSON Room Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Room -> Value # toEncoding :: Room -> Encoding # toJSONList :: [Room] -> Value # toEncodingList :: [Room] -> Encoding #
FromJSON Room Source #	`Room` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Room # parseJSONList :: Value -> Parser [Room] #
SparkListItem Room Source #	`RoomList` wraps `Room`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList Room :: Type Source # Methods unwrap :: ToList Room -> [Room] Source #
type ToList Room Source #
Instance details Defined in Network.CiscoSpark.Types type ToList Room = RoomList

newtype RoomId Source #

Identifying Room.

Constructors

RoomId Text

Instances

Eq RoomId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoomId -> RoomId -> Bool # (/=) :: RoomId -> RoomId -> Bool #
Show RoomId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoomId -> ShowS # show :: RoomId -> String # showList :: [RoomId] -> ShowS #
Generic RoomId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep RoomId :: Type -> Type # Methods from :: RoomId -> Rep RoomId x # to :: Rep RoomId x -> RoomId #
ToJSON RoomId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: RoomId -> Value # toEncoding :: RoomId -> Encoding # toJSONList :: [RoomId] -> Value # toEncodingList :: [RoomId] -> Encoding #
FromJSON RoomId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser RoomId # parseJSONList :: Value -> Parser [RoomId] #
SparkDetail RoomId Source #	User can get detail of a room.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: RoomId -> Text Source #
SparkResponse RoomId Source #	Get detail for a room API uses "RoomId' and responses `Room`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse RoomId :: Type Source #
SparkApiPath RoomId Source #	Get detail for a room API uses `RoomId` and path "rooms".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: RoomId -> ByteString Source #
type Rep RoomId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep RoomId = D1 (MetaData "RoomId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "RoomId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse RoomId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse RoomId = Room

newtype RoomTitle Source #

Title text of Room.

Constructors

RoomTitle Text

Instances

Eq RoomTitle Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoomTitle -> RoomTitle -> Bool # (/=) :: RoomTitle -> RoomTitle -> Bool #
Show RoomTitle Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoomTitle -> ShowS # show :: RoomTitle -> String # showList :: [RoomTitle] -> ShowS #
Generic RoomTitle Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep RoomTitle :: Type -> Type # Methods from :: RoomTitle -> Rep RoomTitle x # to :: Rep RoomTitle x -> RoomTitle #
ToJSON RoomTitle Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: RoomTitle -> Value # toEncoding :: RoomTitle -> Encoding # toJSONList :: [RoomTitle] -> Value # toEncodingList :: [RoomTitle] -> Encoding #
FromJSON RoomTitle Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser RoomTitle # parseJSONList :: Value -> Parser [RoomTitle] #
type Rep RoomTitle Source #
Instance details Defined in Network.CiscoSpark.Types type Rep RoomTitle = D1 (MetaData "RoomTitle" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "RoomTitle" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data RoomType Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoomType -> RoomType -> Bool # (/=) :: RoomType -> RoomType -> Bool #
Show RoomType Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoomType -> ShowS # show :: RoomType -> String # showList :: [RoomType] -> ShowS #
ToJSON RoomType Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: RoomType -> Value # toEncoding :: RoomType -> Encoding # toJSONList :: [RoomType] -> Value # toEncodingList :: [RoomType] -> Encoding #
FromJSON RoomType Source #	`RoomType` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser RoomType # parseJSONList :: Value -> Parser [RoomType] #

newtype SipAddr Source #

SIP address.

Constructors

SipAddr Text

Instances

Eq SipAddr Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: SipAddr -> SipAddr -> Bool # (/=) :: SipAddr -> SipAddr -> Bool #
Show SipAddr Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> SipAddr -> ShowS # show :: SipAddr -> String # showList :: [SipAddr] -> ShowS #
Generic SipAddr Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep SipAddr :: Type -> Type # Methods from :: SipAddr -> Rep SipAddr x # to :: Rep SipAddr x -> SipAddr #
ToJSON SipAddr Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: SipAddr -> Value # toEncoding :: SipAddr -> Encoding # toJSONList :: [SipAddr] -> Value # toEncodingList :: [SipAddr] -> Encoding #
FromJSON SipAddr Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser SipAddr # parseJSONList :: Value -> Parser [SipAddr] #
type Rep SipAddr Source #
Instance details Defined in Network.CiscoSpark.Types type Rep SipAddr = D1 (MetaData "SipAddr" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "SipAddr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype RoomList Source #

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

Constructors

RoomList
Fields roomListItems :: [Room]

Instances

Eq RoomList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoomList -> RoomList -> Bool # (/=) :: RoomList -> RoomList -> Bool #
Show RoomList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoomList -> ShowS # show :: RoomList -> String # showList :: [RoomList] -> ShowS #
ToJSON RoomList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: RoomList -> Value # toEncoding :: RoomList -> Encoding # toJSONList :: [RoomList] -> Value # toEncodingList :: [RoomList] -> Encoding #
FromJSON RoomList Source #	`RoomList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser RoomList # parseJSONList :: Value -> Parser [RoomList] #

data RoomFilter Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoomFilter -> RoomFilter -> Bool # (/=) :: RoomFilter -> RoomFilter -> Bool #
Show RoomFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoomFilter -> ShowS # show :: RoomFilter -> String # showList :: [RoomFilter] -> ShowS #
Generic RoomFilter Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep RoomFilter :: Type -> Type # Methods from :: RoomFilter -> Rep RoomFilter x # to :: Rep RoomFilter x -> RoomFilter #
Default RoomFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods def :: RoomFilter #
SparkFilter RoomFilter Source #	User can list rooms with filter parameter.
Instance details Defined in Network.CiscoSpark.Types Methods toFilterList :: RoomFilter -> [(ByteString, Maybe ByteString)] Source #
SparkResponse RoomFilter Source #	List rooms API uses `RoomFilter` and responses `Room`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse RoomFilter :: Type Source #
SparkApiPath RoomFilter Source #	List rooms API uses `RoomFilter` and path "rooms".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: RoomFilter -> ByteString Source #
type Rep RoomFilter Source #
Instance details Defined in Network.CiscoSpark.Types type Rep RoomFilter = D1 (MetaData "RoomFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" False) (C1 (MetaCons "RoomFilter" PrefixI True) (S1 (MetaSel (Just "roomFilterTeamId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe TeamId)) :: (S1 (MetaSel (Just "roomFilterRoomType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe RoomType)) :: S1 (MetaSel (Just "roomFilterSortBy") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe RoomFilterSortBy)))))
type ToResponse RoomFilter Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse RoomFilter = Room

data RoomFilterSortBy Source #

Sorting option for room list API.

Constructors

RoomFilterSortById
RoomFilterSortByLastActivity
RoomFilterSortByCreated

Instances

Eq RoomFilterSortBy Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoomFilterSortBy -> RoomFilterSortBy -> Bool # (/=) :: RoomFilterSortBy -> RoomFilterSortBy -> Bool #
Show RoomFilterSortBy Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoomFilterSortBy -> ShowS # show :: RoomFilterSortBy -> String # showList :: [RoomFilterSortBy] -> ShowS #

data CreateRoom Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: CreateRoom -> CreateRoom -> Bool # (/=) :: CreateRoom -> CreateRoom -> Bool #
Show CreateRoom Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> CreateRoom -> ShowS # show :: CreateRoom -> String # showList :: [CreateRoom] -> ShowS #
ToJSON CreateRoom Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: CreateRoom -> Value # toEncoding :: CreateRoom -> Encoding # toJSONList :: [CreateRoom] -> Value # toEncodingList :: [CreateRoom] -> Encoding #
FromJSON CreateRoom Source #	`CreateRoom` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser CreateRoom # parseJSONList :: Value -> Parser [CreateRoom] #
SparkCreate CreateRoom Source #	User can create a room.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse CreateRoom Source #	Create room API uses "CreateRoom' and responses `Room`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse CreateRoom :: Type Source #
SparkApiPath CreateRoom Source #	Create room API uses `CreateRoom` and path "rooms".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: CreateRoom -> ByteString Source #
type ToResponse CreateRoom Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse CreateRoom = Room

newtype UpdateRoom Source #

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

Constructors

UpdateRoom
Fields updateRoomTitle :: RoomTitle

Instances

Eq UpdateRoom Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: UpdateRoom -> UpdateRoom -> Bool # (/=) :: UpdateRoom -> UpdateRoom -> Bool #
Show UpdateRoom Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> UpdateRoom -> ShowS # show :: UpdateRoom -> String # showList :: [UpdateRoom] -> ShowS #
ToJSON UpdateRoom Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: UpdateRoom -> Value # toEncoding :: UpdateRoom -> Encoding # toJSONList :: [UpdateRoom] -> Value # toEncodingList :: [UpdateRoom] -> Encoding #
FromJSON UpdateRoom Source #	`UpdateRoom` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser UpdateRoom # parseJSONList :: Value -> Parser [UpdateRoom] #
SparkUpdate UpdateRoom Source #	User can update a room.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse UpdateRoom Source #	Update room API uses "UpdateRoom' and responses `Room`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse UpdateRoom :: Type Source #
SparkApiPath UpdateRoom Source #	Update room API uses `UpdateRoom` and path "rooms".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: UpdateRoom -> ByteString Source #
type ToResponse UpdateRoom Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse UpdateRoom = Room

Membership related types

data Membership Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Membership -> Membership -> Bool # (/=) :: Membership -> Membership -> Bool #
Show Membership Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Membership -> ShowS # show :: Membership -> String # showList :: [Membership] -> ShowS #
ToJSON Membership Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Membership -> Value # toEncoding :: Membership -> Encoding # toJSONList :: [Membership] -> Value # toEncodingList :: [Membership] -> Encoding #
FromJSON Membership Source #	`Membership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Membership # parseJSONList :: Value -> Parser [Membership] #
SparkListItem Membership Source #	`MembershipList` wraps `Membership`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList Membership :: Type Source # Methods unwrap :: ToList Membership -> [Membership] Source #
type ToList Membership Source #
Instance details Defined in Network.CiscoSpark.Types type ToList Membership = MembershipList

newtype MembershipId Source #

Identifying Membership.

Constructors

MembershipId Text

Instances

Eq MembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MembershipId -> MembershipId -> Bool # (/=) :: MembershipId -> MembershipId -> Bool #
Show MembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MembershipId -> ShowS # show :: MembershipId -> String # showList :: [MembershipId] -> ShowS #
Generic MembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep MembershipId :: Type -> Type # Methods from :: MembershipId -> Rep MembershipId x # to :: Rep MembershipId x -> MembershipId #
ToJSON MembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: MembershipId -> Value # toEncoding :: MembershipId -> Encoding # toJSONList :: [MembershipId] -> Value # toEncodingList :: [MembershipId] -> Encoding #
FromJSON MembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser MembershipId # parseJSONList :: Value -> Parser [MembershipId] #
SparkDetail MembershipId Source #	User can get detail of a membership.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: MembershipId -> Text Source #
SparkResponse MembershipId Source #	Get detail for a membership API uses "MembershipId' and responses `Membership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse MembershipId :: Type Source #
SparkApiPath MembershipId Source #	Get detail for a membership API uses `MembershipId` and path "memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: MembershipId -> ByteString Source #
type Rep MembershipId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep MembershipId = D1 (MetaData "MembershipId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "MembershipId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse MembershipId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse MembershipId = Membership

newtype MembershipList Source #

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

Constructors

MembershipList
Fields membershipListItems :: [Membership]

Instances

Eq MembershipList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MembershipList -> MembershipList -> Bool # (/=) :: MembershipList -> MembershipList -> Bool #
Show MembershipList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MembershipList -> ShowS # show :: MembershipList -> String # showList :: [MembershipList] -> ShowS #
ToJSON MembershipList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: MembershipList -> Value # toEncoding :: MembershipList -> Encoding # toJSONList :: [MembershipList] -> Value # toEncodingList :: [MembershipList] -> Encoding #
FromJSON MembershipList Source #	`MembershipList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser MembershipList # parseJSONList :: Value -> Parser [MembershipList] #

data MembershipFilter Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MembershipFilter -> MembershipFilter -> Bool # (/=) :: MembershipFilter -> MembershipFilter -> Bool #
Show MembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MembershipFilter -> ShowS # show :: MembershipFilter -> String # showList :: [MembershipFilter] -> ShowS #
Generic MembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep MembershipFilter :: Type -> Type # Methods from :: MembershipFilter -> Rep MembershipFilter x # to :: Rep MembershipFilter x -> MembershipFilter #
Default MembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods def :: MembershipFilter #
SparkFilter MembershipFilter Source #	User can list memberships with filter parameter.
Instance details Defined in Network.CiscoSpark.Types Methods toFilterList :: MembershipFilter -> [(ByteString, Maybe ByteString)] Source #
SparkResponse MembershipFilter Source #	List memberships API uses `MembershipFilter` and responses `Membership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse MembershipFilter :: Type Source #
SparkApiPath MembershipFilter Source #	List memberships API uses `MembershipFilter` and path "memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: MembershipFilter -> ByteString Source #
type Rep MembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types type Rep MembershipFilter = D1 (MetaData "MembershipFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" False) (C1 (MetaCons "MembershipFilter" PrefixI True) (S1 (MetaSel (Just "membershipFilterRoomId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe RoomId)) :: (S1 (MetaSel (Just "membershipFilterPersonId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe PersonId)) :: S1 (MetaSel (Just "membershipFilterPersonEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Email)))))
type ToResponse MembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse MembershipFilter = Membership

data CreateMembership Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: CreateMembership -> CreateMembership -> Bool # (/=) :: CreateMembership -> CreateMembership -> Bool #
Show CreateMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> CreateMembership -> ShowS # show :: CreateMembership -> String # showList :: [CreateMembership] -> ShowS #
ToJSON CreateMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: CreateMembership -> Value # toEncoding :: CreateMembership -> Encoding # toJSONList :: [CreateMembership] -> Value # toEncodingList :: [CreateMembership] -> Encoding #
FromJSON CreateMembership Source #	`CreateMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser CreateMembership # parseJSONList :: Value -> Parser [CreateMembership] #
SparkCreate CreateMembership Source #	User can create a membership.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse CreateMembership Source #	Create membership API uses "CreateMembership' and responses `Membership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse CreateMembership :: Type Source #
SparkApiPath CreateMembership Source #	Create membership API uses `CreateMembership` and path "memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: CreateMembership -> ByteString Source #
type ToResponse CreateMembership Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse CreateMembership = Membership

newtype UpdateMembership Source #

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

Constructors

UpdateMembership
Fields updateMembershipIsModerator :: Bool

Instances

Eq UpdateMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: UpdateMembership -> UpdateMembership -> Bool # (/=) :: UpdateMembership -> UpdateMembership -> Bool #
Show UpdateMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> UpdateMembership -> ShowS # show :: UpdateMembership -> String # showList :: [UpdateMembership] -> ShowS #
ToJSON UpdateMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: UpdateMembership -> Value # toEncoding :: UpdateMembership -> Encoding # toJSONList :: [UpdateMembership] -> Value # toEncodingList :: [UpdateMembership] -> Encoding #
FromJSON UpdateMembership Source #	`UpdateMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser UpdateMembership # parseJSONList :: Value -> Parser [UpdateMembership] #
SparkUpdate UpdateMembership Source #	User can update a membership.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse UpdateMembership Source #	Update membership API uses "UpdateMembership' and responses `Membership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse UpdateMembership :: Type Source #
SparkApiPath UpdateMembership Source #	Update membership API uses `UpdateMembership` and path "memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: UpdateMembership -> ByteString Source #
type ToResponse UpdateMembership Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse UpdateMembership = Membership

Message related types

data Message Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Show Message Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
ToJSON Message Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #
FromJSON Message Source #	`Message` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #
SparkListItem Message Source #	`MessageList` wraps `Message`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList Message :: Type Source # Methods unwrap :: ToList Message -> [Message] Source #
type ToList Message Source #
Instance details Defined in Network.CiscoSpark.Types type ToList Message = MessageList

newtype MessageId Source #

Identifying Message.

Constructors

MessageId Text

Instances

Eq MessageId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MessageId -> MessageId -> Bool # (/=) :: MessageId -> MessageId -> Bool #
Show MessageId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MessageId -> ShowS # show :: MessageId -> String # showList :: [MessageId] -> ShowS #
Generic MessageId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep MessageId :: Type -> Type # Methods from :: MessageId -> Rep MessageId x # to :: Rep MessageId x -> MessageId #
ToJSON MessageId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: MessageId -> Value # toEncoding :: MessageId -> Encoding # toJSONList :: [MessageId] -> Value # toEncodingList :: [MessageId] -> Encoding #
FromJSON MessageId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser MessageId # parseJSONList :: Value -> Parser [MessageId] #
SparkDetail MessageId Source #	User can get detail of a message.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: MessageId -> Text Source #
SparkResponse MessageId Source #	Get detail for a message API uses "MessageId' and responses `Message`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse MessageId :: Type Source #
SparkApiPath MessageId Source #	Get detail for message API uses `MessageId` and path "messages".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: MessageId -> ByteString Source #
type Rep MessageId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep MessageId = D1 (MetaData "MessageId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "MessageId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse MessageId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse MessageId = Message

newtype MessageText Source #

Body of message in plain text.

Constructors

MessageText Text

Instances

Eq MessageText Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MessageText -> MessageText -> Bool # (/=) :: MessageText -> MessageText -> Bool #
Show MessageText Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MessageText -> ShowS # show :: MessageText -> String # showList :: [MessageText] -> ShowS #
Generic MessageText Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep MessageText :: Type -> Type # Methods from :: MessageText -> Rep MessageText x # to :: Rep MessageText x -> MessageText #
ToJSON MessageText Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: MessageText -> Value # toEncoding :: MessageText -> Encoding # toJSONList :: [MessageText] -> Value # toEncodingList :: [MessageText] -> Encoding #
FromJSON MessageText Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser MessageText # parseJSONList :: Value -> Parser [MessageText] #
type Rep MessageText Source #
Instance details Defined in Network.CiscoSpark.Types type Rep MessageText = D1 (MetaData "MessageText" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "MessageText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype MessageHtml Source #

Body of message in html.

Constructors

MessageHtml Text

Instances

Eq MessageHtml Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MessageHtml -> MessageHtml -> Bool # (/=) :: MessageHtml -> MessageHtml -> Bool #
Show MessageHtml Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MessageHtml -> ShowS # show :: MessageHtml -> String # showList :: [MessageHtml] -> ShowS #
Generic MessageHtml Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep MessageHtml :: Type -> Type # Methods from :: MessageHtml -> Rep MessageHtml x # to :: Rep MessageHtml x -> MessageHtml #
ToJSON MessageHtml Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: MessageHtml -> Value # toEncoding :: MessageHtml -> Encoding # toJSONList :: [MessageHtml] -> Value # toEncodingList :: [MessageHtml] -> Encoding #
FromJSON MessageHtml Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser MessageHtml # parseJSONList :: Value -> Parser [MessageHtml] #
type Rep MessageHtml Source #
Instance details Defined in Network.CiscoSpark.Types type Rep MessageHtml = D1 (MetaData "MessageHtml" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "MessageHtml" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype MessageMarkdown Source #

Body of message in markdown.

Constructors

MessageMarkdown Text

Instances

Eq MessageMarkdown Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MessageMarkdown -> MessageMarkdown -> Bool # (/=) :: MessageMarkdown -> MessageMarkdown -> Bool #
Show MessageMarkdown Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MessageMarkdown -> ShowS # show :: MessageMarkdown -> String # showList :: [MessageMarkdown] -> ShowS #
Generic MessageMarkdown Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep MessageMarkdown :: Type -> Type # Methods from :: MessageMarkdown -> Rep MessageMarkdown x # to :: Rep MessageMarkdown x -> MessageMarkdown #
ToJSON MessageMarkdown Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: MessageMarkdown -> Value # toEncoding :: MessageMarkdown -> Encoding # toJSONList :: [MessageMarkdown] -> Value # toEncodingList :: [MessageMarkdown] -> Encoding #
FromJSON MessageMarkdown Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser MessageMarkdown # parseJSONList :: Value -> Parser [MessageMarkdown] #
type Rep MessageMarkdown Source #
Instance details Defined in Network.CiscoSpark.Types type Rep MessageMarkdown = D1 (MetaData "MessageMarkdown" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "MessageMarkdown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype FileUrl Source #

URL pointing attached file of message.

Constructors

FileUrl Text

Instances

Eq FileUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: FileUrl -> FileUrl -> Bool # (/=) :: FileUrl -> FileUrl -> Bool #
Show FileUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> FileUrl -> ShowS # show :: FileUrl -> String # showList :: [FileUrl] -> ShowS #
Generic FileUrl Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep FileUrl :: Type -> Type # Methods from :: FileUrl -> Rep FileUrl x # to :: Rep FileUrl x -> FileUrl #
ToJSON FileUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: FileUrl -> Value # toEncoding :: FileUrl -> Encoding # toJSONList :: [FileUrl] -> Value # toEncodingList :: [FileUrl] -> Encoding #
FromJSON FileUrl Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser FileUrl # parseJSONList :: Value -> Parser [FileUrl] #
type Rep FileUrl Source #
Instance details Defined in Network.CiscoSpark.Types type Rep FileUrl = D1 (MetaData "FileUrl" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "FileUrl" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype MessageList Source #

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

Constructors

MessageList
Fields messageListItems :: [Message]

Instances

Eq MessageList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MessageList -> MessageList -> Bool # (/=) :: MessageList -> MessageList -> Bool #
Show MessageList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MessageList -> ShowS # show :: MessageList -> String # showList :: [MessageList] -> ShowS #
ToJSON MessageList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: MessageList -> Value # toEncoding :: MessageList -> Encoding # toJSONList :: [MessageList] -> Value # toEncodingList :: [MessageList] -> Encoding #
FromJSON MessageList Source #	`MessageList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser MessageList # parseJSONList :: Value -> Parser [MessageList] #

data MessageFilter Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MessageFilter -> MessageFilter -> Bool # (/=) :: MessageFilter -> MessageFilter -> Bool #
Show MessageFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MessageFilter -> ShowS # show :: MessageFilter -> String # showList :: [MessageFilter] -> ShowS #
SparkFilter MessageFilter Source #	User can list messages with filter parameter.
Instance details Defined in Network.CiscoSpark.Types Methods toFilterList :: MessageFilter -> [(ByteString, Maybe ByteString)] Source #
SparkResponse MessageFilter Source #	List messages API uses `MessageFilter` and responses `Message`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse MessageFilter :: Type Source #
SparkApiPath MessageFilter Source #	List messages API uses `MessageFilter` and path "messages".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: MessageFilter -> ByteString Source #
type ToResponse MessageFilter Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse MessageFilter = Message

data MentionedPeople Source #

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

Constructors

MentionedPeopleMe
MentionedPeople PersonId

Instances

Eq MentionedPeople Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: MentionedPeople -> MentionedPeople -> Bool # (/=) :: MentionedPeople -> MentionedPeople -> Bool #
Show MentionedPeople Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> MentionedPeople -> ShowS # show :: MentionedPeople -> String # showList :: [MentionedPeople] -> ShowS #

data CreateMessage Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: CreateMessage -> CreateMessage -> Bool # (/=) :: CreateMessage -> CreateMessage -> Bool #
Show CreateMessage Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> CreateMessage -> ShowS # show :: CreateMessage -> String # showList :: [CreateMessage] -> ShowS #
ToJSON CreateMessage Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: CreateMessage -> Value # toEncoding :: CreateMessage -> Encoding # toJSONList :: [CreateMessage] -> Value # toEncodingList :: [CreateMessage] -> Encoding #
FromJSON CreateMessage Source #	`CreateMessage` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser CreateMessage # parseJSONList :: Value -> Parser [CreateMessage] #
SparkCreate CreateMessage Source #	User can create a message.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse CreateMessage Source #	Create message API uses "CreateMessage' and responses `Message`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse CreateMessage :: Type Source #
SparkApiPath CreateMessage Source #	Create message API uses `CreateMessage` and path "messages".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: CreateMessage -> ByteString Source #
type ToResponse CreateMessage Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse CreateMessage = Message

Team related types

newtype TeamName Source #

Name of Team

Constructors

TeamName Text

Instances

Eq TeamName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: TeamName -> TeamName -> Bool # (/=) :: TeamName -> TeamName -> Bool #
Show TeamName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> TeamName -> ShowS # show :: TeamName -> String # showList :: [TeamName] -> ShowS #
Generic TeamName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep TeamName :: Type -> Type # Methods from :: TeamName -> Rep TeamName x # to :: Rep TeamName x -> TeamName #
ToJSON TeamName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: TeamName -> Value # toEncoding :: TeamName -> Encoding # toJSONList :: [TeamName] -> Value # toEncodingList :: [TeamName] -> Encoding #
FromJSON TeamName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser TeamName # parseJSONList :: Value -> Parser [TeamName] #
type Rep TeamName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep TeamName = D1 (MetaData "TeamName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "TeamName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype TeamId Source #

Identifying Team.

Constructors

TeamId Text

Instances

Eq TeamId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: TeamId -> TeamId -> Bool # (/=) :: TeamId -> TeamId -> Bool #
Show TeamId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> TeamId -> ShowS # show :: TeamId -> String # showList :: [TeamId] -> ShowS #
Generic TeamId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep TeamId :: Type -> Type # Methods from :: TeamId -> Rep TeamId x # to :: Rep TeamId x -> TeamId #
ToJSON TeamId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: TeamId -> Value # toEncoding :: TeamId -> Encoding # toJSONList :: [TeamId] -> Value # toEncodingList :: [TeamId] -> Encoding #
FromJSON TeamId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser TeamId # parseJSONList :: Value -> Parser [TeamId] #
SparkDetail TeamId Source #	User can get detail of a team.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: TeamId -> Text Source #
SparkResponse TeamId Source #	Get detail for a team API uses "TeamId' and responses `Team`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse TeamId :: Type Source #
SparkApiPath TeamId Source #	Get detail for a team API uses `TeamId` and path "teams".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: TeamId -> ByteString Source #
type Rep TeamId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep TeamId = D1 (MetaData "TeamId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "TeamId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse TeamId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse TeamId = Team

data Team Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Team -> Team -> Bool # (/=) :: Team -> Team -> Bool #
Show Team Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Team -> ShowS # show :: Team -> String # showList :: [Team] -> ShowS #
ToJSON Team Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Team -> Value # toEncoding :: Team -> Encoding # toJSONList :: [Team] -> Value # toEncodingList :: [Team] -> Encoding #
FromJSON Team Source #	`Team` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Team # parseJSONList :: Value -> Parser [Team] #
SparkListItem Team Source #	`TeamList` wraps `Team`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList Team :: Type Source # Methods unwrap :: ToList Team -> [Team] Source #
type ToList Team Source #
Instance details Defined in Network.CiscoSpark.Types type ToList Team = TeamList

newtype TeamList Source #

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

Constructors

TeamList
Fields teamListItems :: [Team]

Instances

Eq TeamList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: TeamList -> TeamList -> Bool # (/=) :: TeamList -> TeamList -> Bool #
Show TeamList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> TeamList -> ShowS # show :: TeamList -> String # showList :: [TeamList] -> ShowS #
ToJSON TeamList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: TeamList -> Value # toEncoding :: TeamList -> Encoding # toJSONList :: [TeamList] -> Value # toEncodingList :: [TeamList] -> Encoding #
FromJSON TeamList Source #	`TeamList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser TeamList # parseJSONList :: Value -> Parser [TeamList] #

newtype CreateTeam Source #

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

Constructors

CreateTeam
Fields createTeamName :: TeamName

Instances

Eq CreateTeam Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: CreateTeam -> CreateTeam -> Bool # (/=) :: CreateTeam -> CreateTeam -> Bool #
Show CreateTeam Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> CreateTeam -> ShowS # show :: CreateTeam -> String # showList :: [CreateTeam] -> ShowS #
ToJSON CreateTeam Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: CreateTeam -> Value # toEncoding :: CreateTeam -> Encoding # toJSONList :: [CreateTeam] -> Value # toEncodingList :: [CreateTeam] -> Encoding #
FromJSON CreateTeam Source #	`CreateTeam` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser CreateTeam # parseJSONList :: Value -> Parser [CreateTeam] #
SparkCreate CreateTeam Source #	User can create a team.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse CreateTeam Source #	Create team API uses "CreateTeam' and responses `Team`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse CreateTeam :: Type Source #
SparkApiPath CreateTeam Source #	Create team API uses `CreateTeam` and path "teams".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: CreateTeam -> ByteString Source #
type ToResponse CreateTeam Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse CreateTeam = Team

newtype UpdateTeam Source #

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

Constructors

UpdateTeam
Fields updateTeamName :: TeamName

Instances

Eq UpdateTeam Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: UpdateTeam -> UpdateTeam -> Bool # (/=) :: UpdateTeam -> UpdateTeam -> Bool #
Show UpdateTeam Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> UpdateTeam -> ShowS # show :: UpdateTeam -> String # showList :: [UpdateTeam] -> ShowS #
ToJSON UpdateTeam Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: UpdateTeam -> Value # toEncoding :: UpdateTeam -> Encoding # toJSONList :: [UpdateTeam] -> Value # toEncodingList :: [UpdateTeam] -> Encoding #
FromJSON UpdateTeam Source #	`UpdateTeam` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser UpdateTeam # parseJSONList :: Value -> Parser [UpdateTeam] #
SparkUpdate UpdateTeam Source #	User can update a team.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse UpdateTeam Source #	Update team API uses "UpdateTeam' and responses `Team`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse UpdateTeam :: Type Source #
SparkApiPath UpdateTeam Source #	Update team API uses `UpdateTeam` and path "teams".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: UpdateTeam -> ByteString Source #
type ToResponse UpdateTeam Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse UpdateTeam = Team

Team Membership related types

data TeamMembership Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: TeamMembership -> TeamMembership -> Bool # (/=) :: TeamMembership -> TeamMembership -> Bool #
Show TeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> TeamMembership -> ShowS # show :: TeamMembership -> String # showList :: [TeamMembership] -> ShowS #
ToJSON TeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: TeamMembership -> Value # toEncoding :: TeamMembership -> Encoding # toJSONList :: [TeamMembership] -> Value # toEncodingList :: [TeamMembership] -> Encoding #
FromJSON TeamMembership Source #	`TeamMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser TeamMembership # parseJSONList :: Value -> Parser [TeamMembership] #
SparkListItem TeamMembership Source #	`TeamMembershipList` wraps `TeamMembership`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList TeamMembership :: Type Source # Methods unwrap :: ToList TeamMembership -> [TeamMembership] Source #
type ToList TeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types type ToList TeamMembership = TeamMembershipList

newtype TeamMembershipId Source #

Identifying TeamMembership.

Constructors

TeamMembershipId Text

Instances

Eq TeamMembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: TeamMembershipId -> TeamMembershipId -> Bool # (/=) :: TeamMembershipId -> TeamMembershipId -> Bool #
Show TeamMembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> TeamMembershipId -> ShowS # show :: TeamMembershipId -> String # showList :: [TeamMembershipId] -> ShowS #
Generic TeamMembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep TeamMembershipId :: Type -> Type # Methods from :: TeamMembershipId -> Rep TeamMembershipId x # to :: Rep TeamMembershipId x -> TeamMembershipId #
ToJSON TeamMembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: TeamMembershipId -> Value # toEncoding :: TeamMembershipId -> Encoding # toJSONList :: [TeamMembershipId] -> Value # toEncodingList :: [TeamMembershipId] -> Encoding #
FromJSON TeamMembershipId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser TeamMembershipId # parseJSONList :: Value -> Parser [TeamMembershipId] #
SparkDetail TeamMembershipId Source #	User can get detail of a team membership.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: TeamMembershipId -> Text Source #
SparkResponse TeamMembershipId Source #	Get detail for a team membership API uses "TeamMembershipId' and responses `TeamMembership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse TeamMembershipId :: Type Source #
SparkApiPath TeamMembershipId Source #	Get detail for a team membership API uses `TeamMembershipId` and path "team/memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: TeamMembershipId -> ByteString Source #
type Rep TeamMembershipId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep TeamMembershipId = D1 (MetaData "TeamMembershipId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "TeamMembershipId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse TeamMembershipId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse TeamMembershipId = TeamMembership

newtype TeamMembershipList Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: TeamMembershipList -> TeamMembershipList -> Bool # (/=) :: TeamMembershipList -> TeamMembershipList -> Bool #
Show TeamMembershipList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> TeamMembershipList -> ShowS # show :: TeamMembershipList -> String # showList :: [TeamMembershipList] -> ShowS #
ToJSON TeamMembershipList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: TeamMembershipList -> Value # toEncoding :: TeamMembershipList -> Encoding # toJSONList :: [TeamMembershipList] -> Value # toEncodingList :: [TeamMembershipList] -> Encoding #
FromJSON TeamMembershipList Source #	`TeamMembershipList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser TeamMembershipList # parseJSONList :: Value -> Parser [TeamMembershipList] #

newtype TeamMembershipFilter Source #

Optional query strings for team membership list API

Constructors

TeamMembershipFilter
Fields teamMembershipFilterTeamId :: TeamId List membership only in given team.

Instances

Eq TeamMembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: TeamMembershipFilter -> TeamMembershipFilter -> Bool # (/=) :: TeamMembershipFilter -> TeamMembershipFilter -> Bool #
Show TeamMembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> TeamMembershipFilter -> ShowS # show :: TeamMembershipFilter -> String # showList :: [TeamMembershipFilter] -> ShowS #
SparkFilter TeamMembershipFilter Source #	User can list team membership with filter parameter.
Instance details Defined in Network.CiscoSpark.Types Methods toFilterList :: TeamMembershipFilter -> [(ByteString, Maybe ByteString)] Source #
SparkResponse TeamMembershipFilter Source #	List team memberships API uses `TeamMembershipFilter` and responses `TeamMembership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse TeamMembershipFilter :: Type Source #
SparkApiPath TeamMembershipFilter Source #	List team memberships API uses `TeamMembershipFilter` and path "team/memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: TeamMembershipFilter -> ByteString Source #
type ToResponse TeamMembershipFilter Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse TeamMembershipFilter = TeamMembership

data CreateTeamMembership Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: CreateTeamMembership -> CreateTeamMembership -> Bool # (/=) :: CreateTeamMembership -> CreateTeamMembership -> Bool #
Show CreateTeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> CreateTeamMembership -> ShowS # show :: CreateTeamMembership -> String # showList :: [CreateTeamMembership] -> ShowS #
ToJSON CreateTeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: CreateTeamMembership -> Value # toEncoding :: CreateTeamMembership -> Encoding # toJSONList :: [CreateTeamMembership] -> Value # toEncodingList :: [CreateTeamMembership] -> Encoding #
FromJSON CreateTeamMembership Source #	`CreateTeamMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser CreateTeamMembership # parseJSONList :: Value -> Parser [CreateTeamMembership] #
SparkCreate CreateTeamMembership Source #	User can create a teamMembership.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse CreateTeamMembership Source #	Create teamMembership API uses "CreateTeamMembership' and responses `TeamMembership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse CreateTeamMembership :: Type Source #
SparkApiPath CreateTeamMembership Source #	Create teamMembership API uses `CreateTeamMembership` and path "team/memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: CreateTeamMembership -> ByteString Source #
type ToResponse CreateTeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse CreateTeamMembership = TeamMembership

newtype UpdateTeamMembership Source #

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

Constructors

UpdateTeamMembership
Fields updateTeamMembershipIsModerator :: Bool

Instances

Eq UpdateTeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: UpdateTeamMembership -> UpdateTeamMembership -> Bool # (/=) :: UpdateTeamMembership -> UpdateTeamMembership -> Bool #
Show UpdateTeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> UpdateTeamMembership -> ShowS # show :: UpdateTeamMembership -> String # showList :: [UpdateTeamMembership] -> ShowS #
ToJSON UpdateTeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: UpdateTeamMembership -> Value # toEncoding :: UpdateTeamMembership -> Encoding # toJSONList :: [UpdateTeamMembership] -> Value # toEncodingList :: [UpdateTeamMembership] -> Encoding #
FromJSON UpdateTeamMembership Source #	`UpdateTeamMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser UpdateTeamMembership # parseJSONList :: Value -> Parser [UpdateTeamMembership] #
SparkUpdate UpdateTeamMembership Source #	User can update a teamMembership.
Instance details Defined in Network.CiscoSpark.Types
SparkResponse UpdateTeamMembership Source #	Update teamMembership API uses "UpdateTeamMembership' and responses `TeamMembership`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse UpdateTeamMembership :: Type Source #
SparkApiPath UpdateTeamMembership Source #	Update teamMembership API uses `UpdateTeamMembership` and path "team/memberships".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: UpdateTeamMembership -> ByteString Source #
type ToResponse UpdateTeamMembership Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse UpdateTeamMembership = TeamMembership

Organization related types

data Organization Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Organization -> Organization -> Bool # (/=) :: Organization -> Organization -> Bool #
Show Organization Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Organization -> ShowS # show :: Organization -> String # showList :: [Organization] -> ShowS #
ToJSON Organization Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Organization -> Value # toEncoding :: Organization -> Encoding # toJSONList :: [Organization] -> Value # toEncodingList :: [Organization] -> Encoding #
FromJSON Organization Source #	`Organization` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Organization # parseJSONList :: Value -> Parser [Organization] #
SparkListItem Organization Source #	`OrganizationList` wraps `Organization`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList Organization :: Type Source # Methods unwrap :: ToList Organization -> [Organization] Source #
type ToList Organization Source #
Instance details Defined in Network.CiscoSpark.Types type ToList Organization = OrganizationList

newtype OrganizationId Source #

Organization identifier which user or team belongs to.

Constructors

OrganizationId Text

Instances

Eq OrganizationId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: OrganizationId -> OrganizationId -> Bool # (/=) :: OrganizationId -> OrganizationId -> Bool #
Show OrganizationId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> OrganizationId -> ShowS # show :: OrganizationId -> String # showList :: [OrganizationId] -> ShowS #
Generic OrganizationId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep OrganizationId :: Type -> Type # Methods from :: OrganizationId -> Rep OrganizationId x # to :: Rep OrganizationId x -> OrganizationId #
ToJSON OrganizationId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: OrganizationId -> Value # toEncoding :: OrganizationId -> Encoding # toJSONList :: [OrganizationId] -> Value # toEncodingList :: [OrganizationId] -> Encoding #
FromJSON OrganizationId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser OrganizationId # parseJSONList :: Value -> Parser [OrganizationId] #
SparkDetail OrganizationId Source #	User can get detail of a organization.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: OrganizationId -> Text Source #
SparkResponse OrganizationId Source #	Get detail for a organization API uses "OrganizationId' and responses `Organization`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse OrganizationId :: Type Source #
SparkApiPath OrganizationId Source #	Get detail for organization API uses `OrganizationId` and path "organizations".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: OrganizationId -> ByteString Source #
type Rep OrganizationId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep OrganizationId = D1 (MetaData "OrganizationId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "OrganizationId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse OrganizationId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse OrganizationId = Organization

newtype OrganizationDisplayName Source #

Display name of Organization

Constructors

OrganizationDisplayName Text

Instances

Eq OrganizationDisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: OrganizationDisplayName -> OrganizationDisplayName -> Bool # (/=) :: OrganizationDisplayName -> OrganizationDisplayName -> Bool #
Show OrganizationDisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> OrganizationDisplayName -> ShowS # show :: OrganizationDisplayName -> String # showList :: [OrganizationDisplayName] -> ShowS #
Generic OrganizationDisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep OrganizationDisplayName :: Type -> Type # Methods from :: OrganizationDisplayName -> Rep OrganizationDisplayName x # to :: Rep OrganizationDisplayName x -> OrganizationDisplayName #
ToJSON OrganizationDisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: OrganizationDisplayName -> Value # toEncoding :: OrganizationDisplayName -> Encoding # toJSONList :: [OrganizationDisplayName] -> Value # toEncodingList :: [OrganizationDisplayName] -> Encoding #
FromJSON OrganizationDisplayName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser OrganizationDisplayName # parseJSONList :: Value -> Parser [OrganizationDisplayName] #
type Rep OrganizationDisplayName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep OrganizationDisplayName = D1 (MetaData "OrganizationDisplayName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "OrganizationDisplayName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype OrganizationList Source #

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

Constructors

OrganizationList
Fields organizationListItems :: [Organization]

Instances

Eq OrganizationList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: OrganizationList -> OrganizationList -> Bool # (/=) :: OrganizationList -> OrganizationList -> Bool #
Show OrganizationList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> OrganizationList -> ShowS # show :: OrganizationList -> String # showList :: [OrganizationList] -> ShowS #
ToJSON OrganizationList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: OrganizationList -> Value # toEncoding :: OrganizationList -> Encoding # toJSONList :: [OrganizationList] -> Value # toEncodingList :: [OrganizationList] -> Encoding #
FromJSON OrganizationList Source #	`OrganizationList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser OrganizationList # parseJSONList :: Value -> Parser [OrganizationList] #

License related types

data License Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: License -> License -> Bool # (/=) :: License -> License -> Bool #
Show License Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> License -> ShowS # show :: License -> String # showList :: [License] -> ShowS #
ToJSON License Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: License -> Value # toEncoding :: License -> Encoding # toJSONList :: [License] -> Value # toEncodingList :: [License] -> Encoding #
FromJSON License Source #	`License` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser License # parseJSONList :: Value -> Parser [License] #
SparkListItem License Source #	`LicenseList` wraps `License`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList License :: Type Source # Methods unwrap :: ToList License -> [License] Source #
type ToList License Source #
Instance details Defined in Network.CiscoSpark.Types type ToList License = LicenseList

newtype LicenseId Source #

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

Constructors

LicenseId Text

Instances

Eq LicenseId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: LicenseId -> LicenseId -> Bool # (/=) :: LicenseId -> LicenseId -> Bool #
Show LicenseId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> LicenseId -> ShowS # show :: LicenseId -> String # showList :: [LicenseId] -> ShowS #
Generic LicenseId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep LicenseId :: Type -> Type # Methods from :: LicenseId -> Rep LicenseId x # to :: Rep LicenseId x -> LicenseId #
ToJSON LicenseId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: LicenseId -> Value # toEncoding :: LicenseId -> Encoding # toJSONList :: [LicenseId] -> Value # toEncodingList :: [LicenseId] -> Encoding #
FromJSON LicenseId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser LicenseId # parseJSONList :: Value -> Parser [LicenseId] #
SparkDetail LicenseId Source #	User can get detail of a license.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: LicenseId -> Text Source #
SparkResponse LicenseId Source #	Get detail for a license API uses "LicenseId' and responses `License`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse LicenseId :: Type Source #
SparkApiPath LicenseId Source #	Get detail for license API uses `LicenseId` and path "licenses".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: LicenseId -> ByteString Source #
type Rep LicenseId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep LicenseId = D1 (MetaData "LicenseId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "LicenseId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse LicenseId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse LicenseId = License

newtype LicenseName Source #

Display name of License

Constructors

LicenseName Text

Instances

Eq LicenseName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: LicenseName -> LicenseName -> Bool # (/=) :: LicenseName -> LicenseName -> Bool #
Show LicenseName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> LicenseName -> ShowS # show :: LicenseName -> String # showList :: [LicenseName] -> ShowS #
Generic LicenseName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep LicenseName :: Type -> Type # Methods from :: LicenseName -> Rep LicenseName x # to :: Rep LicenseName x -> LicenseName #
ToJSON LicenseName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: LicenseName -> Value # toEncoding :: LicenseName -> Encoding # toJSONList :: [LicenseName] -> Value # toEncodingList :: [LicenseName] -> Encoding #
FromJSON LicenseName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser LicenseName # parseJSONList :: Value -> Parser [LicenseName] #
type Rep LicenseName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep LicenseName = D1 (MetaData "LicenseName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "LicenseName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype LicenseUnit Source #

Counting number of granted or consumed License

Constructors

LicenseUnit Integer

Instances

Eq LicenseUnit Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: LicenseUnit -> LicenseUnit -> Bool # (/=) :: LicenseUnit -> LicenseUnit -> Bool #
Show LicenseUnit Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> LicenseUnit -> ShowS # show :: LicenseUnit -> String # showList :: [LicenseUnit] -> ShowS #
Generic LicenseUnit Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep LicenseUnit :: Type -> Type # Methods from :: LicenseUnit -> Rep LicenseUnit x # to :: Rep LicenseUnit x -> LicenseUnit #
ToJSON LicenseUnit Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: LicenseUnit -> Value # toEncoding :: LicenseUnit -> Encoding # toJSONList :: [LicenseUnit] -> Value # toEncodingList :: [LicenseUnit] -> Encoding #
FromJSON LicenseUnit Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser LicenseUnit # parseJSONList :: Value -> Parser [LicenseUnit] #
type Rep LicenseUnit Source #
Instance details Defined in Network.CiscoSpark.Types type Rep LicenseUnit = D1 (MetaData "LicenseUnit" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "LicenseUnit" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)))

newtype LicenseList Source #

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

Constructors

LicenseList
Fields licenseListItems :: [License]

Instances

Eq LicenseList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: LicenseList -> LicenseList -> Bool # (/=) :: LicenseList -> LicenseList -> Bool #
Show LicenseList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> LicenseList -> ShowS # show :: LicenseList -> String # showList :: [LicenseList] -> ShowS #
ToJSON LicenseList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: LicenseList -> Value # toEncoding :: LicenseList -> Encoding # toJSONList :: [LicenseList] -> Value # toEncodingList :: [LicenseList] -> Encoding #
FromJSON LicenseList Source #	`LicenseList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser LicenseList # parseJSONList :: Value -> Parser [LicenseList] #

newtype LicenseFilter Source #

Optional query strings for license list API

Constructors

LicenseFilter
Fields licenseFilterOrgId :: Maybe OrganizationId List licenses only applicable to given organization.

Instances

Eq LicenseFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: LicenseFilter -> LicenseFilter -> Bool # (/=) :: LicenseFilter -> LicenseFilter -> Bool #
Show LicenseFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> LicenseFilter -> ShowS # show :: LicenseFilter -> String # showList :: [LicenseFilter] -> ShowS #
Generic LicenseFilter Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep LicenseFilter :: Type -> Type # Methods from :: LicenseFilter -> Rep LicenseFilter x # to :: Rep LicenseFilter x -> LicenseFilter #
Default LicenseFilter Source #
Instance details Defined in Network.CiscoSpark.Types Methods def :: LicenseFilter #
SparkFilter LicenseFilter Source #	User can list licenses with filter parameter.
Instance details Defined in Network.CiscoSpark.Types Methods toFilterList :: LicenseFilter -> [(ByteString, Maybe ByteString)] Source #
SparkResponse LicenseFilter Source #	List licenses API uses `LicenseFilter` and responses `License`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse LicenseFilter :: Type Source #
SparkApiPath LicenseFilter Source #	List licenses API uses `LicenseFilter` and path "licenses".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: LicenseFilter -> ByteString Source #
type Rep LicenseFilter Source #
Instance details Defined in Network.CiscoSpark.Types type Rep LicenseFilter = D1 (MetaData "LicenseFilter" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "LicenseFilter" PrefixI True) (S1 (MetaSel (Just "licenseFilterOrgId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OrganizationId))))
type ToResponse LicenseFilter Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse LicenseFilter = License

Role related types

data Role Source #

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 Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: Role -> Role -> Bool # (/=) :: Role -> Role -> Bool #
Show Role Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> Role -> ShowS # show :: Role -> String # showList :: [Role] -> ShowS #
ToJSON Role Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: Role -> Value # toEncoding :: Role -> Encoding # toJSONList :: [Role] -> Value # toEncodingList :: [Role] -> Encoding #
FromJSON Role Source #	`Role` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser Role # parseJSONList :: Value -> Parser [Role] #
SparkListItem Role Source #	`RoleList` wraps `Role`
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToList Role :: Type Source # Methods unwrap :: ToList Role -> [Role] Source #
type ToList Role Source #
Instance details Defined in Network.CiscoSpark.Types type ToList Role = RoleList

newtype RoleId Source #

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

Constructors

RoleId Text

Instances

Eq RoleId Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoleId -> RoleId -> Bool # (/=) :: RoleId -> RoleId -> Bool #
Show RoleId Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoleId -> ShowS # show :: RoleId -> String # showList :: [RoleId] -> ShowS #
Generic RoleId Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep RoleId :: Type -> Type # Methods from :: RoleId -> Rep RoleId x # to :: Rep RoleId x -> RoleId #
ToJSON RoleId Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: RoleId -> Value # toEncoding :: RoleId -> Encoding # toJSONList :: [RoleId] -> Value # toEncodingList :: [RoleId] -> Encoding #
FromJSON RoleId Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser RoleId # parseJSONList :: Value -> Parser [RoleId] #
SparkDetail RoleId Source #	User can get detail of a role.
Instance details Defined in Network.CiscoSpark.Types Methods toIdStr :: RoleId -> Text Source #
SparkResponse RoleId Source #	Get detail for a role API uses "RoleId' and responses `Role`.
Instance details Defined in Network.CiscoSpark.Types Associated Types type ToResponse RoleId :: Type Source #
SparkApiPath RoleId Source #	Get detail for role API uses `RoleId` and path "roles".
Instance details Defined in Network.CiscoSpark.Types Methods apiPath :: RoleId -> ByteString Source #
type Rep RoleId Source #
Instance details Defined in Network.CiscoSpark.Types type Rep RoleId = D1 (MetaData "RoleId" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "RoleId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type ToResponse RoleId Source #
Instance details Defined in Network.CiscoSpark.Types type ToResponse RoleId = Role

newtype RoleName Source #

Name of Role.

Constructors

RoleName Text

Instances

Eq RoleName Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoleName -> RoleName -> Bool # (/=) :: RoleName -> RoleName -> Bool #
Show RoleName Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoleName -> ShowS # show :: RoleName -> String # showList :: [RoleName] -> ShowS #
Generic RoleName Source #
Instance details Defined in Network.CiscoSpark.Types Associated Types type Rep RoleName :: Type -> Type # Methods from :: RoleName -> Rep RoleName x # to :: Rep RoleName x -> RoleName #
ToJSON RoleName Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: RoleName -> Value # toEncoding :: RoleName -> Encoding # toJSONList :: [RoleName] -> Value # toEncodingList :: [RoleName] -> Encoding #
FromJSON RoleName Source #
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser RoleName # parseJSONList :: Value -> Parser [RoleName] #
type Rep RoleName Source #
Instance details Defined in Network.CiscoSpark.Types type Rep RoleName = D1 (MetaData "RoleName" "Network.CiscoSpark.Types" "cisco-spark-api-0.1.0.4-7N32BESAftiBRSGVOsHhQ" True) (C1 (MetaCons "RoleName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype RoleList Source #

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

Constructors

RoleList
Fields roleListItems :: [Role]

Instances

Eq RoleList Source #
Instance details Defined in Network.CiscoSpark.Types Methods (==) :: RoleList -> RoleList -> Bool # (/=) :: RoleList -> RoleList -> Bool #
Show RoleList Source #
Instance details Defined in Network.CiscoSpark.Types Methods showsPrec :: Int -> RoleList -> ShowS # show :: RoleList -> String # showList :: [RoleList] -> ShowS #
ToJSON RoleList Source #
Instance details Defined in Network.CiscoSpark.Types Methods toJSON :: RoleList -> Value # toEncoding :: RoleList -> Encoding # toJSONList :: [RoleList] -> Value # toEncodingList :: [RoleList] -> Encoding #
FromJSON RoleList Source #	`RoleList` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.CiscoSpark.Types Methods parseJSON :: Value -> Parser RoleList # parseJSONList :: Value -> Parser [RoleList] #

Functions

Getting detail of an entity

getDetail Source #

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))) Source #

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 () Source #

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 () Source #

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

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

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

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

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

Creating an entity

createEntity Source #

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))) Source #

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

Updating an entity

updateEntity Source #

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))) Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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.