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

Network.WebexTeams.Types

Description

This module defines most of types and records used in webex-teams-api package. Records used for REST communications are designed to be converted from / to JSON using Aeson package. Those records are also 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 doesn't pre-generate those lenses for you because it is so easy. Please create them by yourself as needed.

Synopsis

peoplePath :: ByteString
roomsPath :: ByteString
membershipsPath :: ByteString
messagesPath :: ByteString
teamsPath :: ByteString
teamMembershipsPath :: ByteString
organizationsPath :: ByteString
licensesPath :: ByteString
rolesPath :: ByteString
webhooksPath :: ByteString
class FromJSON (ToList i) => WebexTeamsListItem i where
- type ToList i
- unwrap :: ToList i -> [i]
class WebexTeamsApiPath a where
- apiPath :: a -> ByteString
class FromJSON (ToResponse a) => WebexTeamsResponse a where
- type ToResponse a
class (WebexTeamsApiPath a, WebexTeamsResponse a) => WebexTeamsDetail a where
- toIdStr :: a -> Text
class (WebexTeamsApiPath a, WebexTeamsResponse a) => WebexTeamsFilter a where
- toFilterList :: a -> [(ByteString, Maybe ByteString)]
class (WebexTeamsApiPath a, WebexTeamsResponse a, ToJSON a) => WebexTeamsCreate a
class (WebexTeamsApiPath a, WebexTeamsResponse a, ToJSON a) => WebexTeamsUpdate a
newtype Timestamp = Timestamp Text
newtype ErrorCode = ErrorCode Text
data ErrorTitle = ErrorTitle {
- errorTitleCode :: ErrorCode
- errorTitleReason :: Text
}
newtype Errors = Errors {
- errorsTitle :: ErrorTitle
}
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 OrganizationId = OrganizationId Text
newtype RoleId = RoleId Text
newtype LicenseId = LicenseId Text
newtype Timezone = Timezone Text
data PersonStatus
- = PersonStatusActive
- | PersonStatusInactive
- | PersonStatusOutOfOffice
- | PersonStatusDoNotDisturb
- | PersonStatusUnknown
data PersonType
- = PersonTypePerson
- | PersonTypeBot
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 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]
}
newtype TeamId = TeamId Text
newtype TeamName = TeamName 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
}
newtype TeamMembershipId = TeamMembershipId Text
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 TeamMembershipList = TeamMembershipList {
- teamMembershipListItems :: [TeamMembership]
}
newtype TeamMembershipFilter = TeamMembershipFilter {
- teamMembershipFilterTeamId :: TeamId
}
defaultTeamMembershipFilter :: TeamId -> TeamMembershipFilter
data CreateTeamMembership = CreateTeamMembership {
- createTeamMembershipTeamId :: TeamId
- createTeamMembershipPersonId :: Maybe PersonId
- createTeamMembershipPersonEmail :: Maybe Email
- createTeamMembershipIsModerator :: Maybe Bool
}
newtype UpdateTeamMembership = UpdateTeamMembership {
- updateTeamMembershipIsModerator :: Bool
}
newtype RoomId = RoomId Text
newtype RoomTitle = RoomTitle Text
newtype SipAddr = SipAddr Text
data RoomType
- = RoomTypeDirect
- | RoomTypeGroup
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 RoomList = RoomList {
- roomListItems :: [Room]
}
data RoomFilterSortBy
- = RoomFilterSortById
- | RoomFilterSortByLastActivity
- | RoomFilterSortByCreated
data RoomFilter = RoomFilter {
- roomFilterTeamId :: Maybe TeamId
- roomFilterRoomType :: Maybe RoomType
- roomFilterSortBy :: Maybe RoomFilterSortBy
}
roomTypeToFilterString :: RoomType -> ByteString
roomFilterSortByToFilterString :: RoomFilterSortBy -> ByteString
data CreateRoom = CreateRoom {
- createRoomTitle :: RoomTitle
- createRoomTeamId :: Maybe TeamId
}
newtype UpdateRoom = UpdateRoom {
- updateRoomTitle :: RoomTitle
}
newtype MembershipId = MembershipId Text
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 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
}
newtype MessageId = MessageId Text
newtype MessageText = MessageText Text
newtype MessageHtml = MessageHtml Text
newtype MessageMarkdown = MessageMarkdown Text
newtype FileUrl = FileUrl Text
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 MessageList = MessageList {
- messageListItems :: [Message]
}
data MentionedPeople
- = MentionedPeopleMe
- | MentionedPeople PersonId
data MessageFilter = MessageFilter {
- messageFilterRoomId :: RoomId
- messageFilterMentionedPeople :: Maybe MentionedPeople
- messageFilterBefore :: Maybe Timestamp
- messageFilterBeforeMessage :: Maybe MessageId
}
defaultMessageFilter :: RoomId -> MessageFilter
mentionedPeopleToFilterString :: MentionedPeople -> ByteString
data CreateMessage = CreateMessage {
- createMessageRoomId :: Maybe RoomId
- createMessageToPersonId :: Maybe PersonId
- createMessageToPersonEmail :: Maybe Email
- createMessageText :: Maybe MessageText
- createMessageMarkdown :: Maybe MessageMarkdown
- createMessageFiles :: Maybe [FileUrl]
}
newtype OrganizationDisplayName = OrganizationDisplayName Text
data Organization = Organization {
- organizationId :: OrganizationId
- organizationErrors :: Maybe Errors
- organizationDisplayName :: Maybe OrganizationDisplayName
- organizationCreated :: Maybe Timestamp
}
newtype OrganizationList = OrganizationList {
- organizationListItems :: [Organization]
}
newtype LicenseName = LicenseName Text
newtype LicenseUnit = LicenseUnit Integer
data License = License {
- licenseId :: LicenseId
- licenseErrors :: Maybe Errors
- licenseName :: Maybe LicenseName
- licenseTotalUnits :: Maybe LicenseUnit
- licenseConsumedUnits :: Maybe LicenseUnit
}
newtype LicenseList = LicenseList {
- licenseListItems :: [License]
}
newtype LicenseFilter = LicenseFilter {
- licenseFilterOrgId :: Maybe OrganizationId
}
newtype RoleName = RoleName Text
data Role = Role {
- roleId :: RoleId
- roleErrors :: Maybe Errors
- roleName :: Maybe RoleName
}
newtype RoleList = RoleList {
- roleListItems :: [Role]
}
newtype WebhookId = WebhookId Text
newtype WebhookName = WebhookName Text
newtype WebhookUrl = WebhookUrl Text
newtype WebhookFilter = WebhookFilter Text
newtype WebhookSecret = WebhookSecret Text
data WebhookResource
- = WebhookResourceAll
- | WebhookResourceTeams
- | WebhookResourceMemberships
- | WebhookResourceMessages
- | WebhookResourceRooms
data WebhookEvent
- = WebhookEventAll
- | WebhookEventCreated
- | WebhookEventUpdated
- | WebhookEventDeleted
data Webhook = Webhook {
- webhookId :: WebhookId
- webhookErrors :: Maybe Errors
- webhookName :: Maybe WebhookName
- webhookTargetUrl :: Maybe WebhookUrl
- webhookResource :: Maybe WebhookResource
- webhookEvent :: Maybe WebhookEvent
- webhookFilter :: Maybe WebhookFilter
- webhookSecret :: Maybe WebhookSecret
- webhookCreated :: Maybe Timestamp
}
newtype WebhookList = WebhookList {
- webhookListItems :: [Webhook]
}
data CreateWebhook = CreateWebhook {
- createWebhookName :: WebhookName
- createWebhookTargetUrl :: WebhookUrl
- createWebhookResource :: WebhookResource
- createWebhookEvent :: WebhookEvent
- createWebhookFilter :: Maybe WebhookFilter
- createWebhookSecret :: Maybe WebhookSecret
}
data UpdateWebhook = UpdateWebhook {
- updateWebhookName :: WebhookName
- updateWebhookTargetUrl :: WebhookUrl
}
data WebhookMembershipFilter = WebhookMembershipFilter {
- webhookFilterMembershipRoomId :: Maybe RoomId
- webhookFilterMembershipPersonId :: Maybe PersonId
- webhookFilterMembershipPersonEmail :: Maybe Email
- webhookFilterMembershipIsModerator :: Maybe Bool
}
data WebhookMessageFilter = WebhookMessageFilter {
- webhookFilterMessageRoomId :: Maybe RoomId
- webhookFilterMessageRoomType :: Maybe RoomType
- webhookFilterMessagePersonId :: Maybe PersonId
- webhookFilterMessagePersonEmail :: Maybe Email
- webhookFilterMessagememtionedPeople :: Maybe MentionedPeople
- webhookFilterMessageHasFiles :: Maybe Bool
}
data WebhookRoomFilter = WebhookRoomFilter {
- webhookFilterRoomType :: Maybe RoomType
- webhookFilterRoomIsLocked :: Maybe Bool
}
newtype AppId = AppId Text
data WebhookNotifyOwnedBy
- = WebhookNotifyOwnedByOrg
- | WebhookNotifyOwnedByCreator
data WebhookNotifyStatus
- = WebhookNotifyStatusActive
- | WebhookNotifyStatusDesabled
data WebhookNotify = WebhookNotify {
- webhookNotifyId :: WebhookId
- webhookNotifyName :: WebhookName
- webhookNotifyResource :: WebhookResource
- webhookNotifyEvent :: WebhookEvent
- webhookNotifyFilter :: WebhookFilter
- webhookNotifyOrgId :: Organization
- webhookNotifyCreatedBy :: PersonId
- webhookNotifyAppId :: AppId
- webhookNotifyOwnedBy :: WebhookNotifyOwnedBy
- webhookNotifyStatus :: WebhookNotifyStatus
- webhookNotifyActorId :: PersonId
}
newtype WebhookNotifyMembership = WebhookNotifyMembership {
- webhookNotifyMembershipData :: Membership
}
newtype WebhookNotifyMessage = WebhookNotifyMessage {
- webhookNotifyMessageData :: Message
}
newtype WebhookNotifyRoom = WebhookNotifyRoom {
- webhookNotifyRoomData :: Room
}

Documentation

peoplePath :: ByteString Source #

URL path for people API.

roomsPath :: ByteString Source #

URL path for rooms API.

membershipsPath :: ByteString Source #

URL path for memberships API.

messagesPath :: ByteString Source #

URL path for messages API.

teamsPath :: ByteString Source #

URL path for teams API.

teamMembershipsPath :: ByteString Source #

URL path for team memberships API.

organizationsPath :: ByteString Source #

URL path for organizations API.

licensesPath :: ByteString Source #

URL path for licenes API.

rolesPath :: ByteString Source #

URL path for roles API.

webhooksPath :: ByteString Source #

URL path for webhooks API.

class FromJSON (ToList i) => WebexTeamsListItem i where Source #

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.

Associated Types

type ToList i Source #

Associate item type to wrapping list type.

Methods

unwrap :: ToList i -> [i] Source #

Get bare list from wrapped type which can be parsed directly from JSON.

Instances

Instances details

WebexTeamsListItem License Source #

LicenseList wraps License

Instance details

WebexTeamsApiPath CreateMembership Source #	Create membership API uses `CreateMembership` and path "memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateMembership -> ByteString Source #
WebexTeamsApiPath CreateMessage Source #	Create message API uses `CreateMessage` and path "messages".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateMessage -> ByteString Source #
WebexTeamsApiPath CreatePerson Source #	Create person API uses `CreatePerson` and path "people".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreatePerson -> ByteString Source #
WebexTeamsApiPath CreateRoom Source #	Create room API uses `CreateRoom` and path "rooms".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateRoom -> ByteString Source #
WebexTeamsApiPath CreateTeam Source #	Create team API uses `CreateTeam` and path "teams".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateTeam -> ByteString Source #
WebexTeamsApiPath CreateTeamMembership Source #	Create teamMembership API uses `CreateTeamMembership` and path "team/memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateTeamMembership -> ByteString Source #
WebexTeamsApiPath CreateWebhook Source #	Create webhook API uses `CreateWebhook` and path "webhooks".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: CreateWebhook -> ByteString Source #
WebexTeamsApiPath LicenseFilter Source #	List licenses API uses `LicenseFilter` and path "licenses".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: LicenseFilter -> ByteString Source #
WebexTeamsApiPath LicenseId Source #	Get detail for license API uses `LicenseId` and path "licenses".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: LicenseId -> ByteString Source #
WebexTeamsApiPath MembershipFilter Source #	List memberships API uses `MembershipFilter` and path "memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: MembershipFilter -> ByteString Source #
WebexTeamsApiPath MembershipId Source #	Get detail for a membership API uses `MembershipId` and path "memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: MembershipId -> ByteString Source #
WebexTeamsApiPath MessageFilter Source #	List messages API uses `MessageFilter` and path "messages".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: MessageFilter -> ByteString Source #
WebexTeamsApiPath MessageId Source #	Get detail for message API uses `MessageId` and path "messages".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: MessageId -> ByteString Source #
WebexTeamsApiPath OrganizationId Source #	Get detail for organization API uses `OrganizationId` and path "organizations".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: OrganizationId -> ByteString Source #
WebexTeamsApiPath PersonFilter Source #	List people API uses `PersonFilter` and path "people".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: PersonFilter -> ByteString Source #
WebexTeamsApiPath PersonId Source #	Get detail for a person API uses `PersonId` and path "people".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: PersonId -> ByteString Source #
WebexTeamsApiPath RoleId Source #	Get detail for role API uses `RoleId` and path "roles".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: RoleId -> ByteString Source #
WebexTeamsApiPath RoomFilter Source #	List rooms API uses `RoomFilter` and path "rooms".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: RoomFilter -> ByteString Source #
WebexTeamsApiPath RoomId Source #	Get detail for a room API uses `RoomId` and path "rooms".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: RoomId -> ByteString Source #
WebexTeamsApiPath TeamId Source #	Get detail for a team API uses `TeamId` and path "teams".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: TeamId -> ByteString Source #
WebexTeamsApiPath TeamMembershipFilter Source #	List team memberships API uses `TeamMembershipFilter` and path "team/memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: TeamMembershipFilter -> ByteString Source #
WebexTeamsApiPath TeamMembershipId Source #	Get detail for a team membership API uses `TeamMembershipId` and path "team/memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: TeamMembershipId -> ByteString Source #
WebexTeamsApiPath UpdateMembership Source #	Update membership API uses `UpdateMembership` and path "memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: UpdateMembership -> ByteString Source #
WebexTeamsApiPath UpdatePerson Source #	Update person API uses `UpdatePerson` and path "people".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: UpdatePerson -> ByteString Source #
WebexTeamsApiPath UpdateRoom Source #	Update room API uses `UpdateRoom` and path "rooms".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: UpdateRoom -> ByteString Source #
WebexTeamsApiPath UpdateTeam Source #	Update team API uses `UpdateTeam` and path "teams".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: UpdateTeam -> ByteString Source #
WebexTeamsApiPath UpdateTeamMembership Source #	Update teamMembership API uses `UpdateTeamMembership` and path "team/memberships".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: UpdateTeamMembership -> ByteString Source #
WebexTeamsApiPath UpdateWebhook Source #	Update webhook API uses `UpdateWebhook` and path "webhooks".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: UpdateWebhook -> ByteString Source #
WebexTeamsApiPath WebhookId Source #	Get detail for webhook API uses `WebhookId` and path "webhooks".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: WebhookId -> ByteString Source #
WebexTeamsApiPath WebhookMembershipFilter Source #	Create webhook API accepts `WebhookMembershipFilter` and uses path "webhooks".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: WebhookMembershipFilter -> ByteString Source #
WebexTeamsApiPath WebhookMessageFilter Source #	Create webhook API accepts `WebhookMessageFilter` and uses path "webhooks".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: WebhookMessageFilter -> ByteString Source #
WebexTeamsApiPath WebhookRoomFilter Source #	Create webhook API accepts `WebhookRoomFilter` and uses path "webhooks".
Instance details Defined in Network.WebexTeams.Types Methods apiPath :: WebhookRoomFilter -> ByteString Source #

WebexTeamsDetail LicenseId Source #	User can get detail of a license.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: LicenseId -> Text Source #
WebexTeamsDetail MembershipId Source #	User can get detail of a membership.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: MembershipId -> Text Source #
WebexTeamsDetail MessageId Source #	User can get detail of a message.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: MessageId -> Text Source #
WebexTeamsDetail OrganizationId Source #	User can get detail of a organization.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: OrganizationId -> Text Source #
WebexTeamsDetail PersonId Source #	User can get detail of a person.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: PersonId -> Text Source #
WebexTeamsDetail RoleId Source #	User can get detail of a role.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: RoleId -> Text Source #
WebexTeamsDetail RoomId Source #	User can get detail of a room.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: RoomId -> Text Source #
WebexTeamsDetail TeamId Source #	User can get detail of a team.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: TeamId -> Text Source #
WebexTeamsDetail TeamMembershipId Source #	User can get detail of a team membership.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: TeamMembershipId -> Text Source #
WebexTeamsDetail WebhookId Source #	User can get detail of a webhook.
Instance details Defined in Network.WebexTeams.Types Methods toIdStr :: WebhookId -> Text Source #

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

WebexTeamsCreate CreateMembership Source #	User can create a membership.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsCreate CreateMessage Source #	User can create a message.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsCreate CreatePerson Source #	User can create a person.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsCreate CreateRoom Source #	User can create a room.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsCreate CreateTeam Source #	User can create a team.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsCreate CreateTeamMembership Source #	User can create a teamMembership.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsCreate CreateWebhook Source #	User can create a webhook.
Instance details Defined in Network.WebexTeams.Types

WebexTeamsUpdate UpdateMembership Source #	User can update a membership.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsUpdate UpdatePerson Source #	User can update a person.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsUpdate UpdateRoom Source #	User can update a room.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsUpdate UpdateTeam Source #	User can update a team.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsUpdate UpdateTeamMembership Source #	User can update a teamMembership.
Instance details Defined in Network.WebexTeams.Types
WebexTeamsUpdate UpdateWebhook Source #	User can update a webhook.
Instance details Defined in Network.WebexTeams.Types

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

FromJSON ErrorTitle Source #	`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] # omittedField :: Maybe ErrorTitle #
ToJSON ErrorTitle Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: ErrorTitle -> Value # toEncoding :: ErrorTitle -> Encoding # toJSONList :: [ErrorTitle] -> Value # toEncodingList :: [ErrorTitle] -> Encoding # omitField :: ErrorTitle -> Bool #
Show ErrorTitle Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> ErrorTitle -> ShowS # show :: ErrorTitle -> String # showList :: [ErrorTitle] -> ShowS #
Eq ErrorTitle Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: ErrorTitle -> ErrorTitle -> Bool # (/=) :: ErrorTitle -> ErrorTitle -> Bool #

FromJSON Errors Source #	`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] # omittedField :: Maybe Errors #
ToJSON Errors Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: Errors -> Value # toEncoding :: Errors -> Encoding # toJSONList :: [Errors] -> Value # toEncodingList :: [Errors] -> Encoding # omitField :: Errors -> Bool #
Show Errors Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> Errors -> ShowS # show :: Errors -> String # showList :: [Errors] -> ShowS #
Eq Errors Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: Errors -> Errors -> Bool # (/=) :: Errors -> Errors -> Bool #

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".

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

FromJSON PersonType Source #	`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] # omittedField :: Maybe PersonType #
ToJSON PersonType Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: PersonType -> Value # toEncoding :: PersonType -> Encoding # toJSONList :: [PersonType] -> Value # toEncodingList :: [PersonType] -> Encoding # omitField :: PersonType -> Bool #
Show PersonType Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> PersonType -> ShowS # show :: PersonType -> String # showList :: [PersonType] -> ShowS #
Eq PersonType Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: PersonType -> PersonType -> Bool # (/=) :: PersonType -> PersonType -> Bool #

FromJSON PersonList Source #	`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] # omittedField :: Maybe PersonList #
ToJSON PersonList Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: PersonList -> Value # toEncoding :: PersonList -> Encoding # toJSONList :: [PersonList] -> Value # toEncodingList :: [PersonList] -> Encoding # omitField :: PersonList -> Bool #
Show PersonList Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> PersonList -> ShowS # show :: PersonList -> String # showList :: [PersonList] -> ShowS #
Eq PersonList Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: PersonList -> PersonList -> Bool # (/=) :: PersonList -> PersonList -> Bool #

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.

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.

FromJSON TeamList Source #	`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] # omittedField :: Maybe TeamList #
ToJSON TeamList Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: TeamList -> Value # toEncoding :: TeamList -> Encoding # toJSONList :: [TeamList] -> Value # toEncodingList :: [TeamList] -> Encoding # omitField :: TeamList -> Bool #
Show TeamList Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> TeamList -> ShowS # show :: TeamList -> String # showList :: [TeamList] -> ShowS #
Eq TeamList Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: TeamList -> TeamList -> Bool # (/=) :: TeamList -> TeamList -> Bool #

TeamMembershipList
Fields teamMembershipListItems :: [TeamMembership]

FromJSON TeamMembershipList Source #	`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] # omittedField :: Maybe TeamMembershipList #
ToJSON TeamMembershipList Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: TeamMembershipList -> Value # toEncoding :: TeamMembershipList -> Encoding # toJSONList :: [TeamMembershipList] -> Value # toEncodingList :: [TeamMembershipList] -> Encoding # omitField :: TeamMembershipList -> Bool #
Show TeamMembershipList Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> TeamMembershipList -> ShowS # show :: TeamMembershipList -> String # showList :: [TeamMembershipList] -> ShowS #
Eq TeamMembershipList Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: TeamMembershipList -> TeamMembershipList -> Bool # (/=) :: TeamMembershipList -> TeamMembershipList -> Bool #

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

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.

UpdateTeamMembership
Fields updateTeamMembershipIsModerator :: Bool

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

FromJSON RoomType Source #	`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] # omittedField :: Maybe RoomType #
ToJSON RoomType Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: RoomType -> Value # toEncoding :: RoomType -> Encoding # toJSONList :: [RoomType] -> Value # toEncodingList :: [RoomType] -> Encoding # omitField :: RoomType -> Bool #
Show RoomType Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> RoomType -> ShowS # show :: RoomType -> String # showList :: [RoomType] -> ShowS #
Eq RoomType Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: RoomType -> RoomType -> Bool # (/=) :: RoomType -> RoomType -> Bool #

FromJSON RoomList Source #	`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] # omittedField :: Maybe RoomList #
ToJSON RoomList Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: RoomList -> Value # toEncoding :: RoomList -> Encoding # toJSONList :: [RoomList] -> Value # toEncodingList :: [RoomList] -> Encoding # omitField :: RoomList -> Bool #
Show RoomList Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> RoomList -> ShowS # show :: RoomList -> String # showList :: [RoomList] -> ShowS #
Eq RoomList Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: RoomList -> RoomList -> Bool # (/=) :: RoomList -> RoomList -> Bool #

RoomFilterSortById
RoomFilterSortByLastActivity
RoomFilterSortByCreated

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

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.

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.

FromJSON MembershipList Source #	`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] # omittedField :: Maybe MembershipList #
ToJSON MembershipList Source #
Instance details Defined in Network.WebexTeams.Types Methods toJSON :: MembershipList -> Value # toEncoding :: MembershipList -> Encoding # toJSONList :: [MembershipList] -> Value # toEncodingList :: [MembershipList] -> Encoding # omitField :: MembershipList -> Bool #
Show MembershipList Source #
Instance details Defined in Network.WebexTeams.Types Methods showsPrec :: Int -> MembershipList -> ShowS # show :: MembershipList -> String # showList :: [MembershipList] -> ShowS #
Eq MembershipList Source #
Instance details Defined in Network.WebexTeams.Types Methods (==) :: MembershipList -> MembershipList -> Bool # (/=) :: MembershipList -> MembershipList -> Bool #

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.

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.