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

Network.WebexTeams

Contents

Types
Functions

Description

This module provides types and functions for accessing Cisco Webex Teams 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 Webex Teams 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.

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 $ streamListWithFilter 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

List and steaming

The WebexTeams module doesn't provide streaming API for REST response returning list of entities. It is because the author of the package wants to keep it streaming library agnostic. Instead, it provides ListReader IO action to read list responses with automatic pagenation. Streaming APIs can be found in separate packages like webex-teams-pipes or webex-teams-conduit.

Support for Lens

This package provides many of records representing objects communicated via Webex Teams 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

class (WebexTeamsApiPath a, WebexTeamsResponse a) => WebexTeamsFilter a
class FromJSON (ToList i) => WebexTeamsListItem i
type family ToResponse a :: *
newtype Authorization = Authorization ByteString
type CiscoSparkRequest = WebexTeamsRequest
data WebexTeamsRequest = WebexTeamsRequest {
- webexTeamsRequestRequest :: Request
- webexTeamsRequestScheme :: String
- webexTeamsRequestAuthority :: 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, WebexTeamsDetail key) => Authorization -> WebexTeamsRequest -> key -> m (Response (ToResponse key))
getDetailEither :: (MonadIO m, WebexTeamsDetail key) => Authorization -> WebexTeamsRequest -> key -> m (Response (Either JSONException (ToResponse key)))
type ListReader a = IO [a]
getListWithFilter :: (MonadIO m, WebexTeamsFilter filter, WebexTeamsListItem (ToResponse filter)) => Authorization -> WebexTeamsRequest -> filter -> m (ListReader (ToResponse filter))
getTeamList :: MonadIO m => Authorization -> WebexTeamsRequest -> m (ListReader Team)
getOrganizationList :: MonadIO m => Authorization -> WebexTeamsRequest -> m (ListReader Organization)
getRoleList :: MonadIO m => Authorization -> WebexTeamsRequest -> m (ListReader Role)
streamEntityWithFilter :: (MonadIO m, WebexTeamsFilter filter, WebexTeamsListItem (ToResponse filter)) => Authorization -> WebexTeamsRequest -> filter -> ConduitT () (ToResponse filter) m ()
streamTeamList :: MonadIO m => Authorization -> WebexTeamsRequest -> ConduitT () Team m ()
streamOrganizationList :: MonadIO m => Authorization -> WebexTeamsRequest -> ConduitT () Organization m ()
streamRoleList :: MonadIO m => Authorization -> WebexTeamsRequest -> ConduitT () Role m ()
createEntity :: (MonadIO m, WebexTeamsCreate createParams) => Authorization -> WebexTeamsRequest -> createParams -> m (Response (ToResponse createParams))
createEntityEither :: (MonadIO m, WebexTeamsCreate createParams) => Authorization -> WebexTeamsRequest -> createParams -> m (Response (Either JSONException (ToResponse createParams)))
updateEntity :: (MonadIO m, WebexTeamsUpdate updateParams) => Authorization -> WebexTeamsRequest -> updateParams -> m (Response (ToResponse updateParams))
updateEntityEither :: (MonadIO m, WebexTeamsUpdate updateParams) => Authorization -> WebexTeamsRequest -> updateParams -> m (Response (Either JSONException (ToResponse updateParams)))
defaultMessageFilter :: RoomId -> MessageFilter
defaultTeamMembershipFilter :: TeamId -> TeamMembershipFilter
deleteRoom :: MonadIO m => Authorization -> WebexTeamsRequest -> RoomId -> m (Response ())
deleteMembership :: MonadIO m => Authorization -> WebexTeamsRequest -> MembershipId -> m (Response ())
deleteMessage :: MonadIO m => Authorization -> WebexTeamsRequest -> MessageId -> m (Response ())
deleteTeam :: MonadIO m => Authorization -> WebexTeamsRequest -> TeamId -> m (Response ())
deleteTeamMembership :: MonadIO m => Authorization -> WebexTeamsRequest -> TeamMembershipId -> m (Response ())

Types

Class and Type Families

class (WebexTeamsApiPath a, WebexTeamsResponse a) => WebexTeamsFilter a #

Convert given filter condition parameter in a concrete type to HTTP query strings.

Minimal complete definition

toFilterList

Instances

WebexTeamsFilter PersonFilter #	User can list people with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: PersonFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter TeamMembershipFilter #	User can list team membership with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: TeamMembershipFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter RoomFilter #	User can list rooms with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: RoomFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter MembershipFilter #	User can list memberships with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: MembershipFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter MessageFilter #	User can list messages with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: MessageFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter LicenseFilter #	User can list licenses with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: LicenseFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter WebhookRoomFilter #	User can filter Webhook events from room.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: WebhookRoomFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter WebhookMessageFilter #	User can filter Webhook events from message.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: WebhookMessageFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsFilter WebhookMembershipFilter #	User can filter Webhook events from membership.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: WebhookMembershipFilter -> [(ByteString, Maybe ByteString)] #

class FromJSON (ToList i) => WebexTeamsListItem i #

WebexTeamsListItem is a type class grouping types with following common usage.

It is used for return value of get-detail APIs.
It is used for element of return value of list APIs.

WebexTeamsListItem also associates the above type to wrapping list type (e.g. associates Person to PersonList). Wrapping type (PersonList in this case) is necessary for parsing JSON from REST API but what we are interested in is bare list such like [Person]. Type family association defined in this class is used for type translation from type of items to type of wrapper.

Minimal complete definition

unwrap

Instances

WebexTeamsListItem Person #	`PersonList` wraps `Person`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Person :: * # Methods unwrap :: ToList Person -> [Person] #
WebexTeamsListItem Team #	`TeamList` wraps `Team`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Team :: * # Methods unwrap :: ToList Team -> [Team] #
WebexTeamsListItem TeamMembership #	`TeamMembershipList` wraps `TeamMembership`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList TeamMembership :: * # Methods unwrap :: ToList TeamMembership -> [TeamMembership] #
WebexTeamsListItem Room #	`RoomList` wraps `Room`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Room :: * # Methods unwrap :: ToList Room -> [Room] #
WebexTeamsListItem Membership #	`MembershipList` wraps `Membership`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Membership :: * # Methods unwrap :: ToList Membership -> [Membership] #
WebexTeamsListItem Message #	`MessageList` wraps `Message`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Message :: * # Methods unwrap :: ToList Message -> [Message] #
WebexTeamsListItem Organization #	`OrganizationList` wraps `Organization`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Organization :: * # Methods unwrap :: ToList Organization -> [Organization] #
WebexTeamsListItem License #	`LicenseList` wraps `License`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList License :: * # Methods unwrap :: ToList License -> [License] #
WebexTeamsListItem Role #	`RoleList` wraps `Role`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Role :: * # Methods unwrap :: ToList Role -> [Role] #
WebexTeamsListItem Webhook #	`WebhookList` wraps `Webhook`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList Webhook :: * # Methods unwrap :: ToList Webhook -> [Webhook] #

type family ToResponse a :: * #

Associate response type to input parameter type such as filter criteria, entity key or create / update parameters.

Instances

type ToResponse LicenseId #
Instance details Defined in Network.WebexTeams.Types type ToResponse LicenseId = License
type ToResponse RoleId #
Instance details Defined in Network.WebexTeams.Types type ToResponse RoleId = Role
type ToResponse OrganizationId #
Instance details Defined in Network.WebexTeams.Types type ToResponse OrganizationId = Organization
type ToResponse PersonId #
Instance details Defined in Network.WebexTeams.Types type ToResponse PersonId = Person
type ToResponse CreatePerson #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreatePerson = Person
type ToResponse PersonFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse PersonFilter = Person
type ToResponse UpdatePerson #
Instance details Defined in Network.WebexTeams.Types type ToResponse UpdatePerson = Person
type ToResponse TeamId #
Instance details Defined in Network.WebexTeams.Types type ToResponse TeamId = Team
type ToResponse CreateTeam #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateTeam = Team
type ToResponse UpdateTeam #
Instance details Defined in Network.WebexTeams.Types type ToResponse UpdateTeam = Team
type ToResponse TeamMembershipId #
Instance details Defined in Network.WebexTeams.Types type ToResponse TeamMembershipId = TeamMembership
type ToResponse CreateTeamMembership #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateTeamMembership = TeamMembership
type ToResponse TeamMembershipFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse TeamMembershipFilter = TeamMembership
type ToResponse UpdateTeamMembership #
Instance details Defined in Network.WebexTeams.Types type ToResponse UpdateTeamMembership = TeamMembership
type ToResponse RoomId #
Instance details Defined in Network.WebexTeams.Types type ToResponse RoomId = Room
type ToResponse CreateRoom #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateRoom = Room
type ToResponse RoomFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse RoomFilter = Room
type ToResponse UpdateRoom #
Instance details Defined in Network.WebexTeams.Types type ToResponse UpdateRoom = Room
type ToResponse MembershipId #
Instance details Defined in Network.WebexTeams.Types type ToResponse MembershipId = Membership
type ToResponse CreateMembership #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateMembership = Membership
type ToResponse MembershipFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse MembershipFilter = Membership
type ToResponse UpdateMembership #
Instance details Defined in Network.WebexTeams.Types type ToResponse UpdateMembership = Membership
type ToResponse MessageId #
Instance details Defined in Network.WebexTeams.Types type ToResponse MessageId = Message
type ToResponse CreateMessage #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateMessage = Message
type ToResponse MessageFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse MessageFilter = Message
type ToResponse LicenseFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse LicenseFilter = License
type ToResponse WebhookId #
Instance details Defined in Network.WebexTeams.Types type ToResponse WebhookId = Webhook
type ToResponse CreateWebhook #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateWebhook = Webhook
type ToResponse UpdateWebhook #
Instance details Defined in Network.WebexTeams.Types type ToResponse UpdateWebhook = Webhook
type ToResponse WebhookRoomFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse WebhookRoomFilter = Webhook
type ToResponse WebhookMessageFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse WebhookMessageFilter = Webhook
type ToResponse WebhookMembershipFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse WebhookMembershipFilter = Webhook

Common Types

newtype Authorization #

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

Constructors

Authorization ByteString

Instances

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

type CiscoSparkRequest = WebexTeamsRequest #

Type synonym for backward compatibility.

data WebexTeamsRequest #

Wrapping Request in order to provide easy default value specifically for Webex Teams public API.

Constructors

WebexTeamsRequest
Fields webexTeamsRequestRequest :: Request Holds pre-set `Request` for REST API. webexTeamsRequestScheme :: String Should be "https:" in production. webexTeamsRequestAuthority :: URIAuth Authority part of request URI.

Instances

Show WebexTeamsRequest #
Instance details Defined in Network.WebexTeams Methods showsPrec :: Int -> WebexTeamsRequest -> ShowS # show :: WebexTeamsRequest -> String # showList :: [WebexTeamsRequest] -> ShowS #
Default WebexTeamsRequest #	Default parameters for HTTP request to Webex Teams REST API.
Instance details Defined in Network.WebexTeams Methods def :: WebexTeamsRequest #

newtype Timestamp #

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

Constructors

Timestamp Text

Instances

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

newtype ErrorCode #

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

Constructors

ErrorCode Text

Instances

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

data ErrorTitle #

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

Constructors

ErrorTitle
Fields errorTitleCode :: ErrorCode Error code of element level error in List API response. errorTitleReason :: Text Reason explanation of the error.

Instances

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

newtype Errors #

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

Refer to API Document for more detail.

Constructors

Errors
Fields errorsTitle :: ErrorTitle

Instances

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

People related types

data Person #

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

newtype PersonId #

Identifying Person describing detail of Webex Teams user or bot.

Constructors

PersonId Text

Instances

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

newtype Email #

Email address of user.

Constructors

Email Text

Instances

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

newtype DisplayName #

Display name of user.

Constructors

DisplayName Text

Instances

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

newtype NickName #

Nickname of user.

Constructors

NickName Text

Instances

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

newtype FirstName #

First name of user.

Constructors

FirstName Text

Instances

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

newtype LastName #

Last name of user.

Constructors

LastName Text

Instances

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

newtype AvatarUrl #

URL pointing to image file of Avatar.

Constructors

AvatarUrl Text

Instances

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

newtype Timezone #

Timezone in timezone name.

Constructors

Timezone Text

Instances

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

data PersonStatus #

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

Constructors

PersonStatusActive	The `Person` is currently active. Decoded from "active".
PersonStatusInactive	The `Person` is currently not active. Decoded from "inactive".
PersonStatusOutOfOffice	Email system of the `Person` currently sets vacation. Decoded from "OutOfOffice".
PersonStatusDoNotDisturb	The `Person` is explicitly indicated do-not-disturb. Decoded from "DoNotDisturb".
PersonStatusUnknown	The status of the `Person` is unknown. Decoded from "unknown".

Instances

Eq PersonStatus #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: PersonStatus -> PersonStatus -> Bool # (/=) :: PersonStatus -> PersonStatus -> Bool #
Show PersonStatus #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> PersonStatus -> ShowS # show :: PersonStatus -> String # showList :: [PersonStatus] -> ShowS #
Generic PersonStatus #
Instance details Defined in Network.WebexTeams.Types Associated Types type Rep PersonStatus :: * -> * # Methods from :: PersonStatus -> Rep PersonStatus x # to :: Rep PersonStatus x -> PersonStatus #
ToJSON PersonStatus #	`PersonStatus` implements `toEncoding` to encode each constructor into JSON enum value.
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: PersonStatus -> Value # toEncoding :: PersonStatus -> Encoding # toJSONList :: [PersonStatus] -> Value # toEncodingList :: [PersonStatus] -> Encoding #
FromJSON PersonStatus #	`PersonStatus` implements `parseJSON` to decode JSON enum value to a constructor.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser PersonStatus # parseJSONList :: Value -> Parser [PersonStatus] #
type Rep PersonStatus #
Instance details Defined in Network.WebexTeams.Types type Rep PersonStatus = D1 (MetaData "PersonStatus" "Network.WebexTeams.Types" "webex-teams-api-0.2.0.0-Lley1OzTymIMLru0MlBZs" False) ((C1 (MetaCons "PersonStatusActive" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "PersonStatusInactive" PrefixI False) (U1 :: -> )) :+: (C1 (MetaCons "PersonStatusOutOfOffice" PrefixI False) (U1 :: -> ) :+: (C1 (MetaCons "PersonStatusDoNotDisturb" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "PersonStatusUnknown" PrefixI False) (U1 :: -> *))))

data PersonType #

PersonType indicates whether the Person is real human or bot.

Constructors

PersonTypePerson	The `Person` is a real human. Decoded from "person".
PersonTypeBot	The `Person` is a bot. Decoded from "bot".

Instances

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

newtype PersonList #

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

Constructors

PersonList
Fields personListItems :: [Person]

Instances

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

data PersonFilter #

Optional query strings for people list API.

Constructors

PersonFilter
Fields personFilterEmail :: Maybe Email Find person who has given email address. personFilterDisplayName :: Maybe DisplayName Find person who has given display name. personFilterOrgId :: Maybe OrganizationId Find person who belongs to given organization.

Instances

Eq PersonFilter #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: PersonFilter -> PersonFilter -> Bool # (/=) :: PersonFilter -> PersonFilter -> Bool #
Show PersonFilter #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> PersonFilter -> ShowS # show :: PersonFilter -> String # showList :: [PersonFilter] -> ShowS #
Generic PersonFilter #
Instance details Defined in Network.WebexTeams.Types Associated Types type Rep PersonFilter :: * -> * # Methods from :: PersonFilter -> Rep PersonFilter x # to :: Rep PersonFilter x -> PersonFilter #
Default PersonFilter #
Instance details Defined in Network.WebexTeams.Types Methods def :: PersonFilter #
WebexTeamsFilter PersonFilter #	User can list people with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: PersonFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsResponse PersonFilter #	List people API uses `PersonFilter` and responses `Person`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse PersonFilter :: * #
WebexTeamsApiPath PersonFilter #	List people API uses `PersonFilter` and path "people".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: PersonFilter -> ByteString #
type Rep PersonFilter #
Instance details Defined in Network.WebexTeams.Types type Rep PersonFilter = D1 (MetaData "PersonFilter" "Network.WebexTeams.Types" "webex-teams-api-0.2.0.0-Lley1OzTymIMLru0MlBZs" 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 #
Instance details Defined in Network.WebexTeams.Types type ToResponse PersonFilter = Person

data CreatePerson #

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

Constructors

CreatePerson

Fields

createPersonEmails :: Maybe [Email]
List of email addresses which the Person has.
createPersonDisplayName :: Maybe DisplayName
Display name of the Person.
createPersonFirstName :: Maybe FirstName
First name of the Person.
createPersonLastName :: Maybe LastName
Last name of the Person.
createPersonAvatar :: Maybe AvatarUrl
URL pointing a image used for Avatar of the Person.
createPersonOrgId :: Maybe OrganizationId
Organization which the Person belongs to.
createPersonRoles :: Maybe [RoleId]
List of roles assigned to the person.
createPersonLicenses :: Maybe [LicenseId]
List of licenses effective on the Person.

Instances

Eq CreatePerson #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: CreatePerson -> CreatePerson -> Bool # (/=) :: CreatePerson -> CreatePerson -> Bool #
Show CreatePerson #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> CreatePerson -> ShowS # show :: CreatePerson -> String # showList :: [CreatePerson] -> ShowS #
ToJSON CreatePerson #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: CreatePerson -> Value # toEncoding :: CreatePerson -> Encoding # toJSONList :: [CreatePerson] -> Value # toEncodingList :: [CreatePerson] -> Encoding #
FromJSON CreatePerson #	`CreatePerson` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser CreatePerson # parseJSONList :: Value -> Parser [CreatePerson] #
WebexTeamsCreate CreatePerson #	User can create a person.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsResponse CreatePerson #	Create person API uses "CreatePerson' and responses `Person`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse CreatePerson :: * #
WebexTeamsApiPath CreatePerson #	Create person API uses `CreatePerson` and path "people".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreatePerson -> ByteString #
type ToResponse CreatePerson #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreatePerson = Person

data UpdatePerson #

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

Constructors

UpdatePerson

Fields

updatePersonDisplayName :: Maybe DisplayName
Display name of the Person.
updatePersonFirstName :: Maybe FirstName
First name of the Person.
updatePersonLastName :: Maybe LastName
Last name of the Person.
updatePersonAvatar :: Maybe AvatarUrl
URL pointing a image used for Avatar of the Person.
updatePersonOrgId :: Maybe OrganizationId
Organization which the Person belongs to.
updatePersonRoles :: Maybe [RoleId]
List of roles assigned to the person.
updatePersonLicenses :: Maybe [LicenseId]
List of licenses effective on the Person.

Instances

Eq UpdatePerson #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: UpdatePerson -> UpdatePerson -> Bool # (/=) :: UpdatePerson -> UpdatePerson -> Bool #
Show UpdatePerson #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> UpdatePerson -> ShowS # show :: UpdatePerson -> String # showList :: [UpdatePerson] -> ShowS #
ToJSON UpdatePerson #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: UpdatePerson -> Value # toEncoding :: UpdatePerson -> Encoding # toJSONList :: [UpdatePerson] -> Value # toEncodingList :: [UpdatePerson] -> Encoding #
FromJSON UpdatePerson #	`UpdatePerson` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser UpdatePerson # parseJSONList :: Value -> Parser [UpdatePerson] #
WebexTeamsUpdate UpdatePerson #	User can update a person.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsResponse UpdatePerson #	Update person API uses "UpdatePerson' and responses `Person`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse UpdatePerson :: * #
WebexTeamsApiPath UpdatePerson #	Update person API uses `UpdatePerson` and path "people".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: UpdatePerson -> ByteString #
type ToResponse UpdatePerson #
Instance details Defined in Network.WebexTeams.Types type ToResponse UpdatePerson = Person

Room related types

data Room #

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

newtype RoomId #

Identifying Room.

Constructors

RoomId Text

Instances

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

newtype RoomTitle #

Title text of Room.

Constructors

RoomTitle Text

Instances

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

data RoomType #

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

Constructors

RoomTypeDirect	The Room is for 1:1. Decoded from "direct".
RoomTypeGroup	The Room is for group. Decoded from "group".

Instances

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

newtype SipAddr #

SIP address.

Constructors

SipAddr Text

Instances

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

newtype RoomList #

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

Constructors

RoomList
Fields roomListItems :: [Room]

Instances

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

data RoomFilter #

Optional query strings for room list API

Constructors

RoomFilter
Fields roomFilterTeamId :: Maybe TeamId List rooms only in given team. roomFilterRoomType :: Maybe RoomType List given type rooms only. roomFilterSortBy :: Maybe RoomFilterSortBy Sort response by given option.

Instances

Eq RoomFilter #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: RoomFilter -> RoomFilter -> Bool # (/=) :: RoomFilter -> RoomFilter -> Bool #
Show RoomFilter #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> RoomFilter -> ShowS # show :: RoomFilter -> String # showList :: [RoomFilter] -> ShowS #
Generic RoomFilter #
Instance details Defined in Network.WebexTeams.Types Associated Types type Rep RoomFilter :: * -> * # Methods from :: RoomFilter -> Rep RoomFilter x # to :: Rep RoomFilter x -> RoomFilter #
Default RoomFilter #
Instance details Defined in Network.WebexTeams.Types Methods def :: RoomFilter #
WebexTeamsFilter RoomFilter #	User can list rooms with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: RoomFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsResponse RoomFilter #	List rooms API uses `RoomFilter` and responses `Room`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse RoomFilter :: * #
WebexTeamsApiPath RoomFilter #	List rooms API uses `RoomFilter` and path "rooms".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: RoomFilter -> ByteString #
type Rep RoomFilter #
Instance details Defined in Network.WebexTeams.Types type Rep RoomFilter = D1 (MetaData "RoomFilter" "Network.WebexTeams.Types" "webex-teams-api-0.2.0.0-Lley1OzTymIMLru0MlBZs" 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 #
Instance details Defined in Network.WebexTeams.Types type ToResponse RoomFilter = Room

data RoomFilterSortBy #

Sorting option for room list API.

Constructors

RoomFilterSortById
RoomFilterSortByLastActivity
RoomFilterSortByCreated

Instances

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

data CreateRoom #

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

Constructors

CreateRoom
Fields createRoomTitle :: RoomTitle Title text of newly created Room. createRoomTeamId :: Maybe TeamId Identifier of `Team` which the Room will belong to. If Nothing, the new Room will be standalone.

Instances

Eq CreateRoom #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: CreateRoom -> CreateRoom -> Bool # (/=) :: CreateRoom -> CreateRoom -> Bool #
Show CreateRoom #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> CreateRoom -> ShowS # show :: CreateRoom -> String # showList :: [CreateRoom] -> ShowS #
ToJSON CreateRoom #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: CreateRoom -> Value # toEncoding :: CreateRoom -> Encoding # toJSONList :: [CreateRoom] -> Value # toEncodingList :: [CreateRoom] -> Encoding #
FromJSON CreateRoom #	`CreateRoom` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser CreateRoom # parseJSONList :: Value -> Parser [CreateRoom] #
WebexTeamsCreate CreateRoom #	User can create a room.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsResponse CreateRoom #	Create room API uses "CreateRoom' and responses `Room`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse CreateRoom :: * #
WebexTeamsApiPath CreateRoom #	Create room API uses `CreateRoom` and path "rooms".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateRoom -> ByteString #
type ToResponse CreateRoom #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateRoom = Room

newtype UpdateRoom #

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

Constructors

UpdateRoom
Fields updateRoomTitle :: RoomTitle

Instances

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

Membership related types

data Membership #

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

Constructors

Membership

Fields

membershipId :: MembershipId
Identifier of the Membership entry.
membershipErrors :: Maybe Errors
Element level error possibly contained in List API response.
membershipRoomId :: Maybe RoomId
Identifier of the Room associated to the Person
membershipPersonId :: Maybe PersonId
Identifier of the Person associated to the Room
membershipPersonEmail :: Maybe Email
Email of the Person
membershipPersonDisplayName :: Maybe DisplayName
Display name of the Person
membershipPersonOrgId :: Maybe OrganizationId
Identifier of Organization which the Person belongs to.
membershipIsModerator :: Maybe Bool
True if the Person is a moderator of the room.
membershipIsMonitor :: Maybe Bool
True if the Person is monitoring the Room.
membershipCreated :: Maybe Timestamp
Timestamp when the Membership was created.

Instances

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

newtype MembershipId #

Identifying Membership.

Constructors

MembershipId Text

Instances

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

newtype MembershipList #

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

Constructors

MembershipList
Fields membershipListItems :: [Membership]

Instances

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

data MembershipFilter #

Optional query strings for room membership list API

Constructors

MembershipFilter
Fields membershipFilterRoomId :: Maybe RoomId List membership only in given room. membershipFilterPersonId :: Maybe PersonId List membership related to given person of personId. membershipFilterPersonEmail :: Maybe Email List membership related to given person of email.

Instances

Eq MembershipFilter #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: MembershipFilter -> MembershipFilter -> Bool # (/=) :: MembershipFilter -> MembershipFilter -> Bool #
Show MembershipFilter #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> MembershipFilter -> ShowS # show :: MembershipFilter -> String # showList :: [MembershipFilter] -> ShowS #
Generic MembershipFilter #
Instance details Defined in Network.WebexTeams.Types Associated Types type Rep MembershipFilter :: * -> * # Methods from :: MembershipFilter -> Rep MembershipFilter x # to :: Rep MembershipFilter x -> MembershipFilter #
Default MembershipFilter #
Instance details Defined in Network.WebexTeams.Types Methods def :: MembershipFilter #
WebexTeamsFilter MembershipFilter #	User can list memberships with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: MembershipFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsResponse MembershipFilter #	List memberships API uses `MembershipFilter` and responses `Membership`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse MembershipFilter :: * #
WebexTeamsApiPath MembershipFilter #	List memberships API uses `MembershipFilter` and path "memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: MembershipFilter -> ByteString #
type Rep MembershipFilter #
Instance details Defined in Network.WebexTeams.Types type Rep MembershipFilter = D1 (MetaData "MembershipFilter" "Network.WebexTeams.Types" "webex-teams-api-0.2.0.0-Lley1OzTymIMLru0MlBZs" 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 #
Instance details Defined in Network.WebexTeams.Types type ToResponse MembershipFilter = Membership

data CreateMembership #

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

Constructors

CreateMembership
Fields createMembershipRoomId :: RoomId Identifier of `Room` which the Person will be added to. createMembershipPersonId :: Maybe PersonId Identifier of `Person` who will be added to the Room. createMembershipPersonEmail :: Maybe Email Email of the Person to be added. createMembershipIsModerator :: Maybe Bool The Person becomes a moderator of the Room if True.

Instances

Eq CreateMembership #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: CreateMembership -> CreateMembership -> Bool # (/=) :: CreateMembership -> CreateMembership -> Bool #
Show CreateMembership #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> CreateMembership -> ShowS # show :: CreateMembership -> String # showList :: [CreateMembership] -> ShowS #
ToJSON CreateMembership #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: CreateMembership -> Value # toEncoding :: CreateMembership -> Encoding # toJSONList :: [CreateMembership] -> Value # toEncodingList :: [CreateMembership] -> Encoding #
FromJSON CreateMembership #	`CreateMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser CreateMembership # parseJSONList :: Value -> Parser [CreateMembership] #
WebexTeamsCreate CreateMembership #	User can create a membership.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsResponse CreateMembership #	Create membership API uses "CreateMembership' and responses `Membership`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse CreateMembership :: * #
WebexTeamsApiPath CreateMembership #	Create membership API uses `CreateMembership` and path "memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateMembership -> ByteString #
type ToResponse CreateMembership #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateMembership = Membership

newtype UpdateMembership #

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

Constructors

UpdateMembership
Fields updateMembershipIsModerator :: Bool

Instances

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

Message related types

data Message #

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

Constructors

Message

Fields

messageId :: MessageId
Identifier of the Message.
messageErrors :: Maybe Errors
Element level error possibly contained in List API response.
messageRoomId :: Maybe RoomId
Identifier of the room where the Message was sent.
messageRoomType :: Maybe RoomType
Type of Room the message was sent to.
messageToPersonId :: Maybe PersonId
Presents in documentation but doesn't appear in actual API response.
messageToPersonEmail :: Maybe Email
Presents in documentation but doesn't appear in actual API response.
messageText :: Maybe MessageText
Message body in plain text.
messageHtml :: Maybe MessageHtml
Message body in HTML.
messageFiles :: Maybe [FileUrl]
URL to files attached to the message.
messagePersonId :: Maybe PersonId
Identifier of Person who sent the message.
messagePersonEmail :: Maybe Email
Email of Person who sent the message.
messageCreated :: Maybe Timestamp
Timestamp when the massage was sent.
messageMentionedPeople :: Maybe [PersonId]
List of identifiers of Person were mentioned in the message.

Instances

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

newtype MessageId #

Identifying Message.

Constructors

MessageId Text

Instances

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

newtype MessageText #

Body of message in plain text.

Constructors

MessageText Text

Instances

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

newtype MessageHtml #

Body of message in html.

Constructors

MessageHtml Text

Instances

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

newtype MessageMarkdown #

Body of message in markdown.

Constructors

MessageMarkdown Text

Instances

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

newtype FileUrl #

URL pointing attached file of message.

Constructors

FileUrl Text

Instances

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

newtype MessageList #

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

Constructors

MessageList
Fields messageListItems :: [Message]

Instances

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

data MessageFilter #

Optional query strings for message list API

Constructors

MessageFilter
Fields messageFilterRoomId :: RoomId Mandatory parameter which room to search. messageFilterMentionedPeople :: Maybe MentionedPeople List messages only mentioned to given person. messageFilterBefore :: Maybe Timestamp List messages posted before given timestamp. messageFilterBeforeMessage :: Maybe MessageId List messages posted before given message.

Instances

Eq MessageFilter #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: MessageFilter -> MessageFilter -> Bool # (/=) :: MessageFilter -> MessageFilter -> Bool #
Show MessageFilter #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> MessageFilter -> ShowS # show :: MessageFilter -> String # showList :: [MessageFilter] -> ShowS #
WebexTeamsFilter MessageFilter #	User can list messages with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: MessageFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsResponse MessageFilter #	List messages API uses `MessageFilter` and responses `Message`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse MessageFilter :: * #
WebexTeamsApiPath MessageFilter #	List messages API uses `MessageFilter` and path "messages".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: MessageFilter -> ByteString #
type ToResponse MessageFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse MessageFilter = Message

data MentionedPeople #

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

Constructors

MentionedPeopleMe
MentionedPeople PersonId

Instances

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

data CreateMessage #

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

Constructors

CreateMessage

Fields

createMessageRoomId :: Maybe RoomId
Identifier of the Room the message will be posted to.
createMessageToPersonId :: Maybe PersonId
Identifier of the Person to whom the direct message will be sent.
createMessageToPersonEmail :: Maybe Email
Email of Person who receives the Message.
createMessageText :: Maybe MessageText
Message body in plain text.
createMessageMarkdown :: Maybe MessageMarkdown
Message body in markdown format.
createMessageFiles :: Maybe [FileUrl]
URLs of Attached files to the message.

Instances

Eq CreateMessage #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: CreateMessage -> CreateMessage -> Bool # (/=) :: CreateMessage -> CreateMessage -> Bool #
Show CreateMessage #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> CreateMessage -> ShowS # show :: CreateMessage -> String # showList :: [CreateMessage] -> ShowS #
ToJSON CreateMessage #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: CreateMessage -> Value # toEncoding :: CreateMessage -> Encoding # toJSONList :: [CreateMessage] -> Value # toEncodingList :: [CreateMessage] -> Encoding #
FromJSON CreateMessage #	`CreateMessage` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser CreateMessage # parseJSONList :: Value -> Parser [CreateMessage] #
WebexTeamsCreate CreateMessage #	User can create a message.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsResponse CreateMessage #	Create message API uses "CreateMessage' and responses `Message`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse CreateMessage :: * #
WebexTeamsApiPath CreateMessage #	Create message API uses `CreateMessage` and path "messages".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateMessage -> ByteString #
type ToResponse CreateMessage #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateMessage = Message

Team related types

newtype TeamName #

Name of Team

Constructors

TeamName Text

Instances

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

newtype TeamId #

Identifying Team.

Constructors

TeamId Text

Instances

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

data Team #

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

Constructors

Team
Fields teamId :: TeamId Identifier of the Team. teamErrors :: Maybe Errors Element level error possibly contained in List API response. teamName :: Maybe TeamName Name of the Team. teamCreatorId :: Maybe PersonId Identifier of the Person who created the Team. teamCreated :: Maybe Timestamp Timestamp when the Team was created.

Instances

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

newtype TeamList #

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

Constructors

TeamList
Fields teamListItems :: [Team]

Instances

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

newtype CreateTeam #

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

Constructors

CreateTeam
Fields createTeamName :: TeamName

Instances

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

newtype UpdateTeam #

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

Constructors

UpdateTeam
Fields updateTeamName :: TeamName

Instances

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

Team Membership related types

data TeamMembership #

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

Constructors

TeamMembership

Fields

teamMembershipId :: TeamMembershipId
Identifier of the TeamMembership entry.
teamMembershipErrors :: Maybe Errors
Element level error possibly contained in List API response.
teamMembershipTeamId :: Maybe TeamId
Identifier of the Team which the Person belongs to.
teamMembershipPersonId :: Maybe PersonId
Identifier of user who belongs to the Team.
teamMembershipPersonEmail :: Maybe Email
Email address of the user identified by the PersonId.
teamMembershipPersonDisplayName :: Maybe DisplayName
Display name of the user identified by the PersonId.
teamMembershipPersonOrgId :: Maybe OrganizationId
Identifier of Organization which the Team blongs to.
teamMembershipIsModerator :: Maybe Bool
The Person is moderator of the Team when True.
teamMembershipCreated :: Maybe Timestamp
Timestamp when the TeamMembership entry created.

Instances

Eq TeamMembership #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: TeamMembership -> TeamMembership -> Bool # (/=) :: TeamMembership -> TeamMembership -> Bool #
Show TeamMembership #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> TeamMembership -> ShowS # show :: TeamMembership -> String # showList :: [TeamMembership] -> ShowS #
ToJSON TeamMembership #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: TeamMembership -> Value # toEncoding :: TeamMembership -> Encoding # toJSONList :: [TeamMembership] -> Value # toEncodingList :: [TeamMembership] -> Encoding #
FromJSON TeamMembership #	`TeamMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser TeamMembership # parseJSONList :: Value -> Parser [TeamMembership] #
WebexTeamsListItem TeamMembership #	`TeamMembershipList` wraps `TeamMembership`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList TeamMembership :: * # Methods unwrap :: ToList TeamMembership -> [TeamMembership] #
type ToList TeamMembership #
Instance details Defined in Network.WebexTeams.Types type ToList TeamMembership = TeamMembershipList

newtype TeamMembershipId #

Identifying TeamMembership.

Constructors

TeamMembershipId Text

Instances

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

newtype TeamMembershipList #

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

Constructors

TeamMembershipList
Fields teamMembershipListItems :: [TeamMembership]

Instances

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

newtype TeamMembershipFilter #

Optional query strings for team membership list API

Constructors

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

Instances

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

data CreateTeamMembership #

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

Constructors

CreateTeamMembership
Fields createTeamMembershipTeamId :: TeamId Identifier of `Team` which the user will be added to. createTeamMembershipPersonId :: Maybe PersonId Identifier of `Person` who will be added to the Team. createTeamMembershipPersonEmail :: Maybe Email Email of the Person to be added. createTeamMembershipIsModerator :: Maybe Bool The user becomes a moderator of the team if True.

Instances

Eq CreateTeamMembership #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: CreateTeamMembership -> CreateTeamMembership -> Bool # (/=) :: CreateTeamMembership -> CreateTeamMembership -> Bool #
Show CreateTeamMembership #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> CreateTeamMembership -> ShowS # show :: CreateTeamMembership -> String # showList :: [CreateTeamMembership] -> ShowS #
ToJSON CreateTeamMembership #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: CreateTeamMembership -> Value # toEncoding :: CreateTeamMembership -> Encoding # toJSONList :: [CreateTeamMembership] -> Value # toEncodingList :: [CreateTeamMembership] -> Encoding #
FromJSON CreateTeamMembership #	`CreateTeamMembership` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser CreateTeamMembership # parseJSONList :: Value -> Parser [CreateTeamMembership] #
WebexTeamsCreate CreateTeamMembership #	User can create a teamMembership.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsResponse CreateTeamMembership #	Create teamMembership API uses "CreateTeamMembership' and responses `TeamMembership`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse CreateTeamMembership :: * #
WebexTeamsApiPath CreateTeamMembership #	Create teamMembership API uses `CreateTeamMembership` and path "team/memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateTeamMembership -> ByteString #
type ToResponse CreateTeamMembership #
Instance details Defined in Network.WebexTeams.Types type ToResponse CreateTeamMembership = TeamMembership

newtype UpdateTeamMembership #

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

Constructors

UpdateTeamMembership
Fields updateTeamMembershipIsModerator :: Bool

Instances

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

Organization related types

data Organization #

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

newtype OrganizationId #

Organization identifier which user or team belongs to.

Constructors

OrganizationId Text

Instances

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

newtype OrganizationDisplayName #

Display name of Organization

Constructors

OrganizationDisplayName Text

Instances

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

newtype OrganizationList #

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

Constructors

OrganizationList
Fields organizationListItems :: [Organization]

Instances

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

License related types

data License #

License is allowance for features and services of Webex Teams 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 #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: License -> License -> Bool # (/=) :: License -> License -> Bool #
Show License #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> License -> ShowS # show :: License -> String # showList :: [License] -> ShowS #
ToJSON License #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: License -> Value # toEncoding :: License -> Encoding # toJSONList :: [License] -> Value # toEncodingList :: [License] -> Encoding #
FromJSON License #	`License` derives ToJSON and FromJSON via deriveJSON template haskell function.
Instance details Defined in Network.WebexTeams.Types Methods parseJSON :: Value -> Parser License # parseJSONList :: Value -> Parser [License] #
WebexTeamsListItem License #	`LicenseList` wraps `License`
Instance details Defined in Network.WebexTeams.Types Associated Types type ToList License :: * # Methods unwrap :: ToList License -> [License] #
type ToList License #
Instance details Defined in Network.WebexTeams.Types type ToList License = LicenseList

newtype LicenseId #

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

Constructors

LicenseId Text

Instances

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

newtype LicenseName #

Display name of License

Constructors

LicenseName Text

Instances

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

newtype LicenseUnit #

Counting number of granted or consumed License

Constructors

LicenseUnit Integer

Instances

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

newtype LicenseList #

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

Constructors

LicenseList
Fields licenseListItems :: [License]

Instances

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

newtype LicenseFilter #

Optional query strings for license list API

Constructors

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

Instances

Eq LicenseFilter #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: LicenseFilter -> LicenseFilter -> Bool # (/=) :: LicenseFilter -> LicenseFilter -> Bool #
Show LicenseFilter #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> LicenseFilter -> ShowS # show :: LicenseFilter -> String # showList :: [LicenseFilter] -> ShowS #
Generic LicenseFilter #
Instance details Defined in Network.WebexTeams.Types Associated Types type Rep LicenseFilter :: * -> * # Methods from :: LicenseFilter -> Rep LicenseFilter x # to :: Rep LicenseFilter x -> LicenseFilter #
Default LicenseFilter #
Instance details Defined in Network.WebexTeams.Types Methods def :: LicenseFilter #
WebexTeamsFilter LicenseFilter #	User can list licenses with filter parameter.
Instance details Defined in Network.WebexTeams.Types Methods toFilterList :: LicenseFilter -> [(ByteString, Maybe ByteString)] #
WebexTeamsResponse LicenseFilter #	List licenses API uses `LicenseFilter` and responses `License`.
Instance details Defined in Network.WebexTeams.Types Associated Types type ToResponse LicenseFilter :: * #
WebexTeamsApiPath LicenseFilter #	List licenses API uses `LicenseFilter` and path "licenses".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: LicenseFilter -> ByteString #
type Rep LicenseFilter #
Instance details Defined in Network.WebexTeams.Types type Rep LicenseFilter = D1 (MetaData "LicenseFilter" "Network.WebexTeams.Types" "webex-teams-api-0.2.0.0-Lley1OzTymIMLru0MlBZs" True) (C1 (MetaCons "LicenseFilter" PrefixI True) (S1 (MetaSel (Just "licenseFilterOrgId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OrganizationId))))
type ToResponse LicenseFilter #
Instance details Defined in Network.WebexTeams.Types type ToResponse LicenseFilter = License

Role related types

data Role #

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

Constructors

Role
Fields roleId :: RoleId Identifier of the Role roleErrors :: Maybe Errors Element level error possibly contained in List API response. roleName :: Maybe RoleName Name of the Role

Instances

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

newtype RoleId #

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

Constructors

RoleId Text

Instances

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

newtype RoleName #

Name of Role.

Constructors

RoleName Text

Instances

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

newtype RoleList #

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

Constructors

RoleList
Fields roleListItems :: [Role]

Instances

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

Functions

Getting detail of an entity

getDetail #

Arguments

:: (MonadIO m, WebexTeamsDetail key)
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> key	One of PersonId, RoomId, MembershipId, MessageId, TeamId, TeamMembershipId, OrganizationId, LicenseId and RoleId.
-> m (Response (ToResponse key))

Get details of a Webex Teams 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, WebexTeamsDetail key) => Authorization -> WebexTeamsRequest -> key -> m (Response (Either JSONException (ToResponse key))) #

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

Streaming response of List API with auto pagenation

type ListReader a = IO [a] #

ListReader is IO action returned by functions for list API (getListWithFilter, getTeamList etc). It is containing URL inside to be accessed. When you call the IO action, it accesses to Webex Teams REST API, parse next page URL if available, then return new IO action. The new IO action contains list of responded items and new URL for next page so you can call the new IO action to get the next page.

Following example demonstrates how you can get all items into single list.

    readAllList :: ListReader i -> IO [i]
    readAllList reader = go []
      where
        go xs = reader >>= chunk -> case chunk of
            [] -> pure xs
            ys -> go (xs <> ys)

Note that this example is only for explaining how ListReader works. Practically you should not do the above because it eagerly creates entire list. You should use streaming APIs instead. Streaming APIs are available via webex-teams-conduit and webex-teams-pipes package.

getListWithFilter :: (MonadIO m, WebexTeamsFilter filter, WebexTeamsListItem (ToResponse filter)) => Authorization -> WebexTeamsRequest -> filter -> m (ListReader (ToResponse filter)) #

Get list with query parameter.

getTeamList :: MonadIO m => Authorization -> WebexTeamsRequest -> m (ListReader Team) #

Return ListReader for Team.

getOrganizationList :: MonadIO m => Authorization -> WebexTeamsRequest -> m (ListReader Organization) #

Return ListReader for Team.

getRoleList :: MonadIO m => Authorization -> WebexTeamsRequest -> m (ListReader Role) #

Return ListReader for Team.

streamEntityWithFilter :: (MonadIO m, WebexTeamsFilter filter, WebexTeamsListItem (ToResponse filter)) => Authorization -> WebexTeamsRequest -> filter -> ConduitT () (ToResponse filter) m () #

Deprecated: Use getListWithFilter or streamListWithFilter of webex-teams-conduit

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

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

Deprecated: Use getTeamList or streamTeamList of webex-teams-conduit

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

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

Deprecated: Use getOrganizationList or streamOrganizationList of webex-teams-conduit

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

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

Deprecated: Use getRoleList or streamRoleList of webex-teams-conduit

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

Creating an entity

createEntity #

Arguments

:: (MonadIO m, WebexTeamsCreate createParams)
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> createParams	One of `CreatePerson`, `CreateRoom`, `CreateMembership`, `CreateMessage`, `CreateTeam` and `CreateTeamMembership`.
-> m (Response (ToResponse createParams))

Create a Webex Teams entity with given parameters.

Creating a new entity of Webex Teams 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, WebexTeamsCreate createParams) => Authorization -> WebexTeamsRequest -> createParams -> m (Response (Either JSONException (ToResponse createParams))) #

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

Updating an entity

updateEntity #

Arguments

:: (MonadIO m, WebexTeamsUpdate updateParams)
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> updateParams	One of `UpdatePerson`, `UpdateRoom`, `UpdateMembership`, `UpdateTeam` and `UpdateTeamMembership`.
-> m (Response (ToResponse updateParams))

Update a Webex Teams entity with given parameters.

Creating a new entity of Webex Teams 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, WebexTeamsUpdate updateParams) => Authorization -> WebexTeamsRequest -> updateParams -> m (Response (Either JSONException (ToResponse updateParams))) #

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

Creating default filter spec from mandatory field

defaultMessageFilter :: RoomId -> MessageFilter #

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

defaultTeamMembershipFilter :: TeamId -> TeamMembershipFilter #

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

Deleting an entity

deleteRoom #

Arguments

:: MonadIO m
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> RoomId	Identifier of a space to be deleted.
-> m (Response ())

Deletes a room, by ID.

deleteMembership #

Arguments

:: MonadIO m
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> MembershipId	Identifier of a space to be deleted.
-> m (Response ())

Deletes a membership, by ID.

deleteMessage #

Arguments

:: MonadIO m
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> MessageId	Identifier of a space to be deleted.
-> m (Response ())

Deletes a message, by ID.

deleteTeam #

Arguments

:: MonadIO m
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> TeamId	Identifier of a space to be deleted.
-> m (Response ())

Deletes a team, by ID.

deleteTeamMembership #

Arguments

:: MonadIO m
=> Authorization	Authorization string against Webex Teams API.
-> WebexTeamsRequest	Predefined part of `Request` commonly used for Webex Teams API.
-> TeamMembershipId	Identifier of a space to be deleted.
-> m (Response ())

Deletes a teamMembership, by ID.