"""Webex Attachment Actions API wrapper.
Copyright (c) 2016-2024 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 ..models.immutable import AttachmentAction
from ..restsession import RestSession
from ..utils import check_type, dict_from_items_with_values
API_ENDPOINT = "attachment/actions"
OBJECT_TYPE = "attachment_action"
[docs]
class AttachmentActionsAPI(object):
"""Webex Attachment Actions API.
Wraps the Webex Attachment Actions API and exposes the API as
native Python methods that return native Python objects.
"""
def __init__(self, session, object_factory):
"""Initialize a new AttachmentActionsAPI object.
Args:
session(RestSession): The RESTful session object to be used for
API calls to the Webex service.
Raises:
TypeError: If the parameter types are incorrect.
"""
check_type(session, RestSession)
super(AttachmentActionsAPI, self).__init__()
self._session = session
self._object_factory = object_factory
[docs]
def create(self, type, messageId, inputs, **request_parameters):
"""Create a new attachment action.
Args:
type(str): The type of action to perform.
messageId(str): The ID of the message which contains the
attachment.
inputs(dict): The attachment action's inputs.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
AttachmentAction: A attachment action object with the details of
the created attachment action.
Raises:
TypeError: If the parameter types are incorrect.
ApiError: If the Webex 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(type, str)
check_type(messageId, str)
check_type(inputs, dict)
post_data = dict_from_items_with_values(
request_parameters, type=type, messageId=messageId, inputs=inputs
)
json_data = self._session.post(API_ENDPOINT, json=post_data)
# Return a attachment action object created from the response JSON data
return self._object_factory(OBJECT_TYPE, json_data)
[docs]
def get(self, id):
"""Get the details for a attachment action, by ID.
Args:
id(str): A unique identifier for the attachment action.
Returns:
AttachmentAction: A Attachment Action object with the details of
the requested attachment action.
Raises:
TypeError: If the parameter types are incorrect.
ApiError: If the Webex cloud returns an error.
"""
check_type(id, str)
# API request
json_data = self._session.get(API_ENDPOINT + "/" + id)
# Return a message object created from the response JSON data
return self._object_factory(OBJECT_TYPE, json_data)