89.0.0

Author: PureCloud Jenkins

README.md

@@ -1,5 +1,5 @@
 ---
-title: PureCloud API SDK - Python
+title: Platform API Client SDK - Python
 ---
 
 [![PyPI version](https://badge.fury.io/py/PureCloudPlatformClientV2.svg)](https://badge.fury.io/py/PureCloudPlatformClientV2)
@@ -57,7 +57,7 @@ print usersApi.get_users_me()
 
 ### Setting the Environment
 
-If connecting to a PureCloud environment other than mypurecloud.com (e.g. mypurecloud.ie), set the new base path before constructing any API classes. The new base path should be the base path to the Platform API for your environment.
+If connecting to a Genesys Cloud environment other than mypurecloud.com (e.g. mypurecloud.ie), set the new base path before constructing any API classes. The new base path should be the base path to the Platform API for your environment.
 
 ```{"language":"python"}
 region = PureCloudRegionHosts.us_east_1
@@ -115,6 +115,6 @@ The SDK's version is incremented according to the [Semantic Versioning Specifica
 
 ## Support
 
-This package is intended to be forwards compatible with v2 of PureCloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK.
+This package is intended to be forwards compatible with v2 of Genesys Cloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK.
 
-For any issues, questions, or suggestions for the SDK, visit the [PureCloud Developer Forum](https://developer.mypurecloud.com/forum/).
+For any issues, questions, or suggestions for the SDK, visit the [Genesys Cloud Developer Forum](https://developer.mypurecloud.com/forum/).

build/PureCloudPlatformClientV2/api_client.py

@@ -185,7 +185,7 @@ def __call_api(self, resource_path, method,
             header_params['Cookie'] = self.cookie
         if header_params:
             header_params = self.sanitize_for_serialization(header_params)
-        header_params['purecloud-sdk'] = '88.0.0'
+        header_params['purecloud-sdk'] = '89.0.0'
 
         # path parameters
         if path_params:

build/PureCloudPlatformClientV2/apis/groups_api.py

@@ -535,7 +535,7 @@ def get_group_members(self, group_id, **kwargs):
     def get_group_profile(self, group_id, **kwargs):
         """
         Get group profile
-        
+        This api is deprecated. Use /api/v2/groups instead
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function
@@ -784,7 +784,7 @@ def get_groups_search(self, q64, **kwargs):
     def get_profiles_groups(self, **kwargs):
         """
         Get group profile listing
-        
+        This api is deprecated. Use /api/v2/groups instead.
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function

build/PureCloudPlatformClientV2/apis/scim_api.py

@@ -473,7 +473,7 @@ def get_scim_groups(self, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param int start_index: The 1-based index of the first query result.
-        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
+        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\".
         :param list[str] attributes: Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
         :param list[str] excluded_attributes: Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta'  attributes will always be present in the output.
         :param str filter: Filters results.
@@ -1025,7 +1025,7 @@ def get_scim_users(self, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param int start_index: The 1-based index of the first query result.
-        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
+        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\".
         :param list[str] attributes: Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
         :param list[str] excluded_attributes: Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes  will always be present in output.
         :param str filter: Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
@@ -1200,7 +1200,7 @@ def get_scim_v2_groups(self, filter, **kwargs):
             for asynchronous request. (optional)
         :param str filter: Filters results. (required)
         :param int start_index: The 1-based index of the first query result.
-        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
+        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\".
         :param list[str] attributes: Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
         :param list[str] excluded_attributes: Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta'  attributes will always be present in the output.
         :return: ScimGroupListResponse
@@ -1754,7 +1754,7 @@ def get_scim_v2_users(self, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param int start_index: The 1-based index of the first query result.
-        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
+        :param int count: The requested number of items per page. A value of 0 returns \"totalResults\".
         :param list[str] attributes: Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
         :param list[str] excluded_attributes: Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes  will always be present in output.
         :param str filter: Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".

build/PureCloudPlatformClientV2/apis/users_api.py

@@ -1342,7 +1342,7 @@ def get_fieldconfig(self, type, **kwargs):
     def get_profiles_users(self, **kwargs):
         """
         Get a user profile listing
-        
+        This api is deprecated. User /api/v2/users
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function
@@ -2086,7 +2086,7 @@ def get_user_outofoffice(self, user_id, **kwargs):
     def get_user_profile(self, user_id, **kwargs):
         """
         Get user profile
-        
+        This api has been deprecated. Use api/v2/users instead
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please define a `callback` function

build/PureCloudPlatformClientV2/configuration.py

@@ -255,5 +255,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v2\n"\
-               "SDK Package Version: 88.0.0".\
+               "SDK Package Version: 89.0.0".\
                format(env=sys.platform, pyversion=sys.version)

build/PureCloudPlatformClientV2/models/action_entity_listing.py

@@ -45,10 +45,10 @@ def __init__(self):
             'page_number': 'int',
             'total': 'int',
             'first_uri': 'str',
-            'previous_uri': 'str',
-            'self_uri': 'str',
             'next_uri': 'str',
+            'self_uri': 'str',
             'last_uri': 'str',
+            'previous_uri': 'str',
             'page_count': 'int'
         }
 
@@ -58,10 +58,10 @@ def __init__(self):
             'page_number': 'pageNumber',
             'total': 'total',
             'first_uri': 'firstUri',
-            'previous_uri': 'previousUri',
-            'self_uri': 'selfUri',
             'next_uri': 'nextUri',
+            'self_uri': 'selfUri',
             'last_uri': 'lastUri',
+            'previous_uri': 'previousUri',
             'page_count': 'pageCount'
         }
 
@@ -70,10 +70,10 @@ def __init__(self):
         self._page_number = None
         self._total = None
         self._first_uri = None
-        self._previous_uri = None
-        self._self_uri = None
         self._next_uri = None
+        self._self_uri = None
         self._last_uri = None
+        self._previous_uri = None
         self._page_count = None
 
     @property
@@ -192,27 +192,27 @@ def first_uri(self, first_uri):
         self._first_uri = first_uri
 
     @property
-    def previous_uri(self):
+    def next_uri(self):
         """
-        Gets the previous_uri of this ActionEntityListing.
+        Gets the next_uri of this ActionEntityListing.
 
 
-        :return: The previous_uri of this ActionEntityListing.
+        :return: The next_uri of this ActionEntityListing.
         :rtype: str
         """
-        return self._previous_uri
+        return self._next_uri
 
-    @previous_uri.setter
-    def previous_uri(self, previous_uri):
+    @next_uri.setter
+    def next_uri(self, next_uri):
         """
-        Sets the previous_uri of this ActionEntityListing.
+        Sets the next_uri of this ActionEntityListing.
 
 
-        :param previous_uri: The previous_uri of this ActionEntityListing.
+        :param next_uri: The next_uri of this ActionEntityListing.
         :type: str
         """
 
-        self._previous_uri = previous_uri
+        self._next_uri = next_uri
 
     @property
     def self_uri(self):
@@ -238,50 +238,50 @@ def self_uri(self, self_uri):
         self._self_uri = self_uri
 
     @property
-    def next_uri(self):
+    def last_uri(self):
         """
-        Gets the next_uri of this ActionEntityListing.
+        Gets the last_uri of this ActionEntityListing.
 
 
-        :return: The next_uri of this ActionEntityListing.
+        :return: The last_uri of this ActionEntityListing.
         :rtype: str
         """
-        return self._next_uri
+        return self._last_uri
 
-    @next_uri.setter
-    def next_uri(self, next_uri):
+    @last_uri.setter
+    def last_uri(self, last_uri):
         """
-        Sets the next_uri of this ActionEntityListing.
+        Sets the last_uri of this ActionEntityListing.
 
 
-        :param next_uri: The next_uri of this ActionEntityListing.
+        :param last_uri: The last_uri of this ActionEntityListing.
         :type: str
         """
 
-        self._next_uri = next_uri
+        self._last_uri = last_uri
 
     @property
-    def last_uri(self):
+    def previous_uri(self):
         """
-        Gets the last_uri of this ActionEntityListing.
+        Gets the previous_uri of this ActionEntityListing.
 
 
-        :return: The last_uri of this ActionEntityListing.
+        :return: The previous_uri of this ActionEntityListing.
         :rtype: str
         """
-        return self._last_uri
+        return self._previous_uri
 
-    @last_uri.setter
-    def last_uri(self, last_uri):
+    @previous_uri.setter
+    def previous_uri(self, previous_uri):
         """
-        Sets the last_uri of this ActionEntityListing.
+        Sets the previous_uri of this ActionEntityListing.
 
 
-        :param last_uri: The last_uri of this ActionEntityListing.
+        :param previous_uri: The previous_uri of this ActionEntityListing.
         :type: str
         """
 
-        self._last_uri = last_uri
+        self._previous_uri = previous_uri
 
     @property
     def page_count(self):