# -*- coding: utf-8 -*-
"""Cisco Identity Services Engine Subscriber API wrapper.
Copyright (c) 2021 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 ...pagination import get_next_page
from ...restsession import RestSession
from ...utils import (
apply_path_params,
check_type,
dict_from_items_with_values,
dict_of_str,
)
[docs]class Subscriber(object):
"""Identity Services Engine Subscriber API (version: 3.2_beta).
Wraps the Identity Services Engine Subscriber
API and exposes the API as native Python
methods that return native Python objects.
"""
def __init__(self, session, object_factory, request_validator):
"""Initialize a new Subscriber
object with the provided RestSession.
Args:
session(RestSession): The RESTful session object to be used for
API calls to the Identity Services Engine service.
Raises:
TypeError: If the parameter types are incorrect.
"""
check_type(session, RestSession)
super(Subscriber, self).__init__()
self._session = session
self._object_factory = object_factory
self._request_validator = request_validator
[docs] def get_all_subscribers(self,
filter=None,
filter_type=None,
page=None,
size=None,
sort=None,
sort_by=None,
headers=None,
**query_parameters):
"""Purpose of this API is to get all Subscribers.
Args:
page(int): page query parameter. Page number.
size(int): size query parameter. Number of objects
returned per page.
filter(basestring): filter query parameter.
Simple filtering should be available
through the filter query string
parameter. The structure of a filter is
a triplet of field operator and value
separated with dots. More than one
filter can be sent. The logical operator
common to ALL filter criteria will be by
default AND, and can be changed by using
the "filterType=or" query string
parameter. Each resource Data model
description should specify if an
attribute is a filtered field.
OPERATOR DESCRIPTION EQ
Equals NEQ Not Equals GT
Greater Than LT Less Then
STARTSW Starts With NSTARTSW
Not Starts With ENDSW Ends With
NENDSW Not Ends With CONTAINS
Contains NCONTAINS Not Contains
.
filter_type(basestring): filterType query parameter. The
logical operator common to ALL filter
criteria will be by default AND, and can
be changed by using the parameter.
sort(basestring): sort query parameter. sort type asc or
desc.
sort_by(basestring): sortBy query parameter. sort column
by which objects needs to be sorted.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(page, (int, basestring, list))
check_type(size, (int, basestring, list))
check_type(filter, basestring)
check_type(filter_type, basestring)
check_type(sort, basestring)
check_type(sort_by, basestring)
_params = {
'page':
page,
'size':
size,
'filter':
filter,
'filterType':
filter_type,
'sort':
sort,
'sortBy':
sort_by,
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
e_url = ('/api/v1/fiveg/subscriber')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_bb725fc737535a23b2459a255a4b9725_v3_2_beta', _api_response)
[docs] def get_all_subscribers_generator(self,
filter=None,
filter_type=None,
page=None,
size=None,
sort=None,
sort_by=None,
headers=None,
**query_parameters):
"""Purpose of this API is to get all Subscribers.
Args:
page(int): page query parameter. Page number.
size(int): size query parameter. Number of objects
returned per page.
filter(basestring): filter query parameter.
Simple filtering should be available
through the filter query string
parameter. The structure of a filter is
a triplet of field operator and value
separated with dots. More than one
filter can be sent. The logical operator
common to ALL filter criteria will be by
default AND, and can be changed by using
the "filterType=or" query string
parameter. Each resource Data model
description should specify if an
attribute is a filtered field.
OPERATOR DESCRIPTION EQ
Equals NEQ Not Equals GT
Greater Than LT Less Then
STARTSW Starts With NSTARTSW
Not Starts With ENDSW Ends With
NENDSW Not Ends With CONTAINS
Contains NCONTAINS Not Contains
.
filter_type(basestring): filterType query parameter. The
logical operator common to ALL filter
criteria will be by default AND, and can
be changed by using the parameter.
sort(basestring): sort query parameter. sort type asc or
desc.
sort_by(basestring): sortBy query parameter. sort column
by which objects needs to be sorted.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
Generator: A generator object containing the following object.
+ RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
yield from get_next_page(
self.get_all_subscribers, dict(
filter=filter,
filter_type=filter_type,
page=page,
size=size,
sort=sort,
sort_by=sort_by,
headers=headers,
**query_parameters
),
access_next_list=["nextPage", "href"],
access_resource_list=["response"])
[docs] def create_subscriber(self,
enabled=None,
friendly_name=None,
identity_groups=None,
imeis=None,
imsi=None,
ki=None,
opc=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Purpose of this API is to create Subscriber holding the IMSI.
Args:
enabled(boolean): Subscriber is enabled or not, property
of the request body.
friendly_name(string): Friendly name for the subscriber,
property of the request body.
identity_groups(string): Identity Group(s). With more
than one idGroups it needs to be comma
seperated, property of the request body.
imeis(string): IMEI to be attached to the subscriber,
property of the request body.
imsi(string): IMSI for Subscriber, property of the
request body.
ki(string): KI, property of the request body.
opc(string): OPC, property of the request body.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
if active_validation and is_xml_payload:
check_type(payload, basestring)
if active_validation and not is_xml_payload:
check_type(payload, dict)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
if is_xml_payload:
_payload = payload
else:
_payload = {
'enabled':
enabled,
'friendlyName':
friendly_name,
'identityGroups':
identity_groups,
'imeis':
imeis,
'imsi':
imsi,
'ki':
ki,
'opc':
opc,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation and not is_xml_payload:
self._request_validator('jsd_c9ea8f91504d9aa46ebd90dd1ab4_v3_2_beta')\
.validate(_payload)
e_url = ('/api/v1/fiveg/subscriber')
endpoint_full_url = apply_path_params(e_url, path_params)
request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
if with_custom_headers:
_api_response = self._session.post(endpoint_full_url, params=_params,
headers=_headers,
**request_params)
else:
_api_response = self._session.post(endpoint_full_url, params=_params,
**request_params)
return self._object_factory('bpm_c9ea8f91504d9aa46ebd90dd1ab4_v3_2_beta', _api_response)
[docs] def bulk_subscriber_operation(self,
item_list=None,
operation=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Create/update/delete Subscribers in bulk.
Args:
item_list(list): ItemList, property of the request body
(list of objects).
operation(string): operation, property of the request
body. Available values are 'Create',
'Delete' and 'Update'.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
if active_validation and is_xml_payload:
check_type(payload, basestring)
if active_validation and not is_xml_payload:
check_type(payload, dict)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
}
if is_xml_payload:
_payload = payload
else:
_payload = {
'ItemList':
item_list,
'operation':
operation,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation and not is_xml_payload:
self._request_validator('jsd_ee509b9ea4465d33bcb6552b30ec32b6_v3_2_beta')\
.validate(_payload)
e_url = ('/api/v1/fiveg/subscriber/bulk')
endpoint_full_url = apply_path_params(e_url, path_params)
request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
if with_custom_headers:
_api_response = self._session.post(endpoint_full_url, params=_params,
headers=_headers,
**request_params)
else:
_api_response = self._session.post(endpoint_full_url, params=_params,
**request_params)
return self._object_factory('bpm_ee509b9ea4465d33bcb6552b30ec32b6_v3_2_beta', _api_response)
[docs] def get_subscriber_by_i_m_s_i(self,
imsi,
headers=None,
**query_parameters):
"""Purpose of this API is to get Subscriber by IMSI.
Args:
imsi(basestring): imsi path parameter. IMSI parameter.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(imsi, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'imsi': imsi,
}
e_url = ('/api/v1/fiveg/subscriber/imsi/{imsi}')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_a1b71359fd0351f3a7f824ce8c4df14a_v3_2_beta', _api_response)
[docs] def get_subscriber_by_id(self,
subscriber_id,
headers=None,
**query_parameters):
"""Purpose of this API is to get Subscriber by ID.
Args:
subscriber_id(basestring): subscriberId path parameter.
Unique id for a subscriber object.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(subscriber_id, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'subscriberId': subscriber_id,
}
e_url = ('/api/v1/fiveg/subscriber/{subscriberId}')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.get(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.get(endpoint_full_url, params=_params)
return self._object_factory('bpm_bf1dfb9226e534cb039880148e47e95_v3_2_beta', _api_response)
[docs] def update_subscriber(self,
subscriber_id,
enabled=None,
friendly_name=None,
identity_groups=None,
imeis=None,
ki=None,
opc=None,
headers=None,
payload=None,
active_validation=True,
**query_parameters):
"""Purpose of this API is to update Subscriber given the
Subscriber's Id and the request payload.
Args:
enabled(boolean): Subscriber is enabled or not, property
of the request body.
friendly_name(string): Friendly name for the subscriber,
property of the request body.
identity_groups(string): Identity Group(s). With more
than one idGroups it needs to be comma
seperated, property of the request body.
imeis(string): IMEI to be attached to the subscriber,
property of the request body.
ki(string): KI, property of the request body.
opc(string): OPC, property of the request body.
subscriber_id(basestring): subscriberId path parameter.
Unique id for a subscriber object.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
if active_validation and is_xml_payload:
check_type(payload, basestring)
if active_validation and not is_xml_payload:
check_type(payload, dict)
check_type(subscriber_id, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'subscriberId': subscriber_id,
}
if is_xml_payload:
_payload = payload
else:
_payload = {
'enabled':
enabled,
'friendlyName':
friendly_name,
'identityGroups':
identity_groups,
'imeis':
imeis,
'ki':
ki,
'opc':
opc,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation and not is_xml_payload:
self._request_validator('jsd_cfc8b401a45650b386d0ae88c2ac3ef4_v3_2_beta')\
.validate(_payload)
e_url = ('/api/v1/fiveg/subscriber/{subscriberId}')
endpoint_full_url = apply_path_params(e_url, path_params)
request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
if with_custom_headers:
_api_response = self._session.put(endpoint_full_url, params=_params,
headers=_headers,
**request_params)
else:
_api_response = self._session.put(endpoint_full_url, params=_params,
**request_params)
return self._object_factory('bpm_cfc8b401a45650b386d0ae88c2ac3ef4_v3_2_beta', _api_response)
[docs] def delete_subscriber(self,
subscriber_id,
headers=None,
**query_parameters):
"""Purpose of this API is to delete the Subscriber given the
Subscriber's Id.
Args:
subscriber_id(basestring): subscriberId path parameter.
Unique id for a subscriber object.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**query_parameters: Additional query parameters (provides
support for parameters that may be added in the future).
Returns:
RestResponse: REST response with following properties:
- headers(MyDict): response headers.
- response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
or the bracket notation.
- content(bytes): representation of the request's response
- text(str): representation of the request's response
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Identity Services Engine cloud returns an error.
"""
check_type(headers, dict)
if headers is not None:
if 'X-Request-ID' in headers:
check_type(headers.get('X-Request-ID'),
basestring)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
check_type(subscriber_id, basestring,
may_be_none=False)
_params = {
}
_params.update(query_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
'subscriberId': subscriber_id,
}
e_url = ('/api/v1/fiveg/subscriber/{subscriberId}')
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
_api_response = self._session.delete(endpoint_full_url, params=_params,
headers=_headers)
else:
_api_response = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory('bpm_ce70db8b014a599d8b6d623c4713b176_v3_2_beta', _api_response)