# -*- coding: utf-8 -*-
"""Webex Teams Messages API wrapper.
Copyright (c) 2016-2020 Cisco and/or its affiliates.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
from builtins import *
from past.builtins import basestring
from requests_toolbelt import MultipartEncoder
from webexteamssdk.models.cards import AdaptiveCard
from ..generator_containers import generator_container
from ..restsession import RestSession
from ..utils import (
check_type, dict_from_items_with_values, is_local_file, is_web_url,
make_attachment, open_local_file,
)
API_ENDPOINT = 'messages'
OBJECT_TYPE = 'message'
[docs]class MessagesAPI(object):
"""Webex Teams Messages API.
Wraps the Webex Teams Messages API and exposes the API as native Python
methods that return native Python objects.
"""
def __init__(self, session, object_factory):
"""Init a new MessagesAPI object with the provided RestSession.
Args:
session(RestSession): The RESTful session object to be used for
API calls to the Webex Teams service.
Raises:
TypeError: If the parameter types are incorrect.
"""
check_type(session, RestSession)
super(MessagesAPI, self).__init__()
self._session = session
self._object_factory = object_factory
[docs] @generator_container
def list(self, roomId, parentId=None, mentionedPeople=None, before=None,
beforeMessage=None, max=50, **request_parameters):
"""Lists messages in a room.
Each message will include content attachments if present.
The list API sorts the messages in descending order by creation date.
This method supports Webex Teams's implementation of RFC5988 Web
Linking to provide pagination support. It returns a generator
container that incrementally yields all messages returned by the
query. The generator will automatically request additional 'pages' of
responses from Webex as needed until all responses have been returned.
The container makes the generator safe for reuse. A new API call will
be made, using the same parameters that were specified when the
generator was created, every time a new iterator is requested from the
container.
Args:
roomId(basestring): List messages for a room, by ID.
parentId(basestring): List messages with a parent, by ID.
mentionedPeople(basestring): List messages where the caller is
mentioned by specifying "me" or the caller `personId`.
before(basestring): List messages sent before a date and time, in
ISO8601 format.
beforeMessage(basestring): List messages sent before a message,
by ID.
max(int): Limit the maximum number of items returned from the Webex
Teams service per request.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
GeneratorContainer: A GeneratorContainer which, when iterated,
yields the messages returned by the Webex Teams query.
Raises:
TypeError: If the parameter types are incorrect.
ApiError: If the Webex Teams cloud returns an error.
"""
check_type(roomId, basestring)
check_type(parentId, basestring, optional=True)
check_type(mentionedPeople, basestring, optional=True)
check_type(before, basestring, optional=True)
check_type(beforeMessage, basestring, optional=True)
check_type(max, int, optional=True)
params = dict_from_items_with_values(
request_parameters,
roomId=roomId,
parentId=parentId,
mentionedPeople=mentionedPeople,
before=before,
beforeMessage=beforeMessage,
max=max,
)
# API request - get items
items = self._session.get_items(API_ENDPOINT, params=params)
# Yield message objects created from the returned items JSON objects
for item in items:
yield self._object_factory(OBJECT_TYPE, item)
[docs] @generator_container
def list_direct(self, personId=None, personEmail=None, parentId=None,
**request_parameters):
"""List all messages in a 1:1 (direct) room.
Use the `personId` or `personEmail` query parameter to specify the
room.
The list API sorts the messages in descending order by creation date.
This method supports Webex Teams's implementation of RFC5988 Web
Linking to provide pagination support. It returns a generator
container that incrementally yields all messages returned by the
query. The generator will automatically request additional 'pages' of
responses from Webex as needed until all responses have been returned.
The container makes the generator safe for reuse. A new API call will
be made, using the same parameters that were specified when the
generator was created, every time a new iterator is requested from the
container.
Args:
personId(basestring): List messages in a 1:1 room, by person ID.
personEmail(basestring): List messages in a 1:1 room, by person
email.
parentId(basestring): List messages with a parent, by ID.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
GeneratorContainer: A GeneratorContainer which, when iterated,
yields the messages returned by the Webex Teams query.
Raises:
TypeError: If the parameter types are incorrect.
ApiError: If the Webex Teams cloud returns an error.
"""
check_type(personId, basestring, optional=True)
check_type(personEmail, basestring, optional=True)
check_type(parentId, basestring, optional=True)
params = dict_from_items_with_values(
request_parameters,
personId=personId,
personEmail=personEmail,
parentId=parentId,
)
# API request - get items
items = self._session.get_items(
API_ENDPOINT + "/direct",
params=params,
)
# Yield message objects created from the returned items JSON objects
for item in items:
yield self._object_factory(OBJECT_TYPE, item)
[docs] def create(self, roomId=None, parentId=None, toPersonId=None,
toPersonEmail=None, text=None, markdown=None, files=None,
attachments=None, **request_parameters):
"""Post a message to a room.
The files parameter is a list, which accepts multiple values to allow
for future expansion, but currently only one file may be included with
the message.
Args:
roomId(basestring): The room ID.
toPersonId(basestring): The ID of the recipient when sending a
private 1:1 message.
toPersonEmail(basestring): The email address of the recipient when
sending a private 1:1 message.
text(basestring): The message, in plain text. If `markdown` is
specified this parameter may be optionally used to provide
alternate text for UI clients that do not support rich text.
markdown(basestring): The message, in markdown format.
files(list): A list of public URL(s) or local path(s) to files to
be posted into the room. Only one file is allowed per message.
attachments(list): Content attachments to attach to the message.
See the Cards Guide for more information.
parentId(basestring): The parent message to reply to. This will
start or reply to a thread.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
Message: A Message object with the details of the created message.
Raises:
TypeError: If the parameter types are incorrect.
ApiError: If the Webex Teams cloud returns an error.
ValueError: If the files parameter is a list of length > 1, or if
the string in the list (the only element in the list) does not
contain a valid URL or path to a local file.
"""
check_type(roomId, basestring, optional=True)
check_type(toPersonId, basestring, optional=True)
check_type(toPersonEmail, basestring, optional=True)
check_type(text, basestring, optional=True)
check_type(markdown, basestring, optional=True)
check_type(files, list, optional=True)
check_type(attachments, list, optional=True)
check_type(parentId, basestring, optional=True)
if files:
if len(files) > 1:
raise ValueError("The `files` parameter should be a list with "
"exactly one (1) item. The files parameter "
"is a list, which accepts multiple values to "
"allow for future expansion, but currently "
"only one file may be included with the "
"message.")
check_type(files[0], basestring)
else:
files = None
# Process and serialize attachments
if attachments:
for item, attachment in enumerate(attachments):
check_type(attachment, (dict, AdaptiveCard))
if isinstance(attachment, AdaptiveCard):
attachments[item] = make_attachment(attachment)
post_data = dict_from_items_with_values(
request_parameters,
roomId=roomId,
toPersonId=toPersonId,
toPersonEmail=toPersonEmail,
text=text,
markdown=markdown,
files=files,
attachments=attachments,
parentId=parentId
)
# API request
if not files or is_web_url(files[0]):
# Standard JSON post
json_data = self._session.post(API_ENDPOINT, json=post_data)
elif is_local_file(files[0]):
# Multipart MIME post
try:
post_data['files'] = open_local_file(files[0])
multipart_data = MultipartEncoder(post_data)
headers = {'Content-type': multipart_data.content_type}
json_data = self._session.post(API_ENDPOINT,
headers=headers,
data=multipart_data)
finally:
post_data['files'].file_object.close()
else:
raise ValueError("The `files` parameter does not contain a vaild "
"URL or path to a local file.")
# Return a message object created from the response JSON data
return self._object_factory(OBJECT_TYPE, json_data)
[docs] def get(self, messageId):
"""Get the details of a message, by ID.
Args:
messageId(basestring): The ID of the message to be retrieved.
Returns:
Message: A Message object with the details of the requested
message.
Raises:
TypeError: If the parameter types are incorrect.
ApiError: If the Webex Teams cloud returns an error.
"""
check_type(messageId, basestring)
# API request
json_data = self._session.get(API_ENDPOINT + '/' + messageId)
# Return a message object created from the response JSON data
return self._object_factory(OBJECT_TYPE, json_data)
[docs] def delete(self, messageId):
"""Delete a message.
Args:
messageId(basestring): The ID of the message to be deleted.
Raises:
TypeError: If the parameter types are incorrect.
ApiError: If the Webex Teams cloud returns an error.
"""
check_type(messageId, basestring)
# API request
self._session.delete(API_ENDPOINT + '/' + messageId)