245.0.0

Author: PureCloud Jenkins

README.md

@@ -5,7 +5,7 @@
 
 Documentation can be found at https://mypurecloud.github.io/platform-client-sdk-python/
 
-Documentation version PureCloudPlatformClientV2 244.0.0
+Documentation version PureCloudPlatformClientV2 245.0.0
 
 ## Preview APIs
 

build/.openapi-generator/FILES

@@ -4201,6 +4201,7 @@ PureCloudPlatformClientV2/models/recipient_listing.py
 PureCloudPlatformClientV2/models/recipient_request.py
 PureCloudPlatformClientV2/models/recognition.py
 PureCloudPlatformClientV2/models/recognition_base.py
+PureCloudPlatformClientV2/models/recognitions.py
 PureCloudPlatformClientV2/models/record.py
 PureCloudPlatformClientV2/models/recorders_state.py
 PureCloudPlatformClientV2/models/recording.py
@@ -4229,6 +4230,8 @@ PureCloudPlatformClientV2/models/recording_job_entity_listing.py
 PureCloudPlatformClientV2/models/recording_job_failed_recording.py
 PureCloudPlatformClientV2/models/recording_jobs_query.py
 PureCloudPlatformClientV2/models/recording_location.py
+PureCloudPlatformClientV2/models/recording_message_receipt.py
+PureCloudPlatformClientV2/models/recording_message_receipt_reason.py
 PureCloudPlatformClientV2/models/recording_messaging_message.py
 PureCloudPlatformClientV2/models/recording_metadata.py
 PureCloudPlatformClientV2/models/recording_notification_template.py
@@ -10060,6 +10063,7 @@ docs/RecipientListing.md
 docs/RecipientRequest.md
 docs/Recognition.md
 docs/RecognitionBase.md
+docs/Recognitions.md
 docs/Record.md
 docs/RecordersState.md
 docs/Recording.md
@@ -10090,6 +10094,8 @@ docs/RecordingJobEntityListing.md
 docs/RecordingJobFailedRecording.md
 docs/RecordingJobsQuery.md
 docs/RecordingLocation.md
+docs/RecordingMessageReceipt.md
+docs/RecordingMessageReceiptReason.md
 docs/RecordingMessagingMessage.md
 docs/RecordingMetadata.md
 docs/RecordingNotificationTemplate.md
@@ -12441,6 +12447,7 @@ docs/get_emails_settings_threading-example.txt
 docs/get_emails_settings_threading-example.txt
 docs/get_employeeengagement_celebrations-example.txt
 docs/get_employeeengagement_recognition-example.txt
+docs/get_employeeengagement_recognitions-example.txt
 docs/get_employeeperformance_externalmetrics_definition-example.txt
 docs/get_employeeperformance_externalmetrics_definitions-example.txt
 docs/get_externalcontacts_contact-example.txt

build/APIData.json

@@ -16139,6 +16139,45 @@
     "return": "Recognition",
     "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.EmployeeEngagementApi();\nrecognition_id = 'recognition_id_example' # str | The Recognition ID\n\ntry:\n    # Gets a single recognition\n    api_response = api_instance.get_employeeengagement_recognition(recognition_id)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EmployeeEngagementApi->get_employeeengagement_recognition: %s\\n\" % e)"
   },
+  "get_employeeengagement_recognitions": {
+    "operationId": "get_employeeengagement_recognitions",
+    "functionName": "get_employeeengagement_recognitions",
+    "signature": "get_employeeengagement_recognitions(direction, recipient, date_start, date_end, page_size, page_number)",
+    "parameters": [
+      {
+        "name": "direction",
+        "type": "str",
+        "required": "false"
+      },
+      {
+        "name": "recipient",
+        "type": "str",
+        "required": "false"
+      },
+      {
+        "name": "date_start",
+        "type": "datetime",
+        "required": "false"
+      },
+      {
+        "name": "date_end",
+        "type": "datetime",
+        "required": "false"
+      },
+      {
+        "name": "page_size",
+        "type": "int",
+        "required": "false"
+      },
+      {
+        "name": "page_number",
+        "type": "int",
+        "required": "false"
+      }
+    ],
+    "return": "Recognitions",
+    "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.EmployeeEngagementApi();\ndirection = ''received'' # str | The direction of the recognitions. (optional) (default to 'received')\nrecipient = 'recipient_example' # str | The ID of the recipient (when direction is sent). (optional)\ndate_start = '2013-10-20T19:20:30+01:00' # datetime | The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)\ndate_end = '2013-10-20T19:20:30+01:00' # datetime | The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional)\npage_size = 100 # int | Page size (optional) (default to 100)\npage_number = 1 # int | Page number (optional) (default to 1)\n\ntry:\n    # Gets sent recognitions\n    api_response = api_instance.get_employeeengagement_recognitions(direction=direction, recipient=recipient, date_start=date_start, date_end=date_end, page_size=page_size, page_number=page_number)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EmployeeEngagementApi->get_employeeengagement_recognitions: %s\\n\" % e)"
+  },
   "patch_employeeengagement_celebration": {
     "operationId": "patch_employeeengagement_celebration",
     "functionName": "patch_employeeengagement_celebration",
@@ -33355,7 +33394,7 @@
   "get_outbound_messagingcampaigns": {
     "operationId": "get_outbound_messagingcampaigns",
     "functionName": "get_outbound_messagingcampaigns",
-    "signature": "get_outbound_messagingcampaigns(page_size, page_number, sort_by, sort_order, name, contact_list_id, division_id, type, sender_sms_phone_number, id, content_template_id, campaign_status)",
+    "signature": "get_outbound_messagingcampaigns(page_size, page_number, sort_by, sort_order, name, contact_list_id, division_id, type, sender_sms_phone_number, id, content_template_id, campaign_status, rule_set_ids)",
     "parameters": [
       {
         "name": "page_size",
@@ -33416,10 +33455,15 @@
         "name": "campaign_status",
         "type": "str",
         "required": "false"
+      },
+      {
+        "name": "rule_set_ids",
+        "type": "list[str]",
+        "required": "false"
       }
     ],
     "return": "MessagingCampaignEntityListing",
-    "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.OutboundApi();\npage_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)\npage_number = 1 # int | Page number (optional) (default to 1)\nsort_by = ''name'' # str | The field to sort by (optional) (default to 'name')\nsort_order = ''ascending'' # str | The direction to sort (optional) (default to 'ascending')\nname = 'name_example' # str | Name (optional)\ncontact_list_id = 'contact_list_id_example' # str | Contact List ID (optional)\ndivision_id = ['division_id_example'] # list[str] | Division ID(s) (optional)\ntype = 'type_example' # str | Campaign Type (optional)\nsender_sms_phone_number = 'sender_sms_phone_number_example' # str | Sender SMS Phone Number (optional)\nid = ['id_example'] # list[str] | A list of messaging campaign ids to bulk fetch (optional)\ncontent_template_id = 'content_template_id_example' # str | Content template ID (optional)\ncampaign_status = 'campaign_status_example' # str | Campaign Status (optional)\n\ntry:\n    # Query a list of Messaging Campaigns\n    api_response = api_instance.get_outbound_messagingcampaigns(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, contact_list_id=contact_list_id, division_id=division_id, type=type, sender_sms_phone_number=sender_sms_phone_number, id=id, content_template_id=content_template_id, campaign_status=campaign_status)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling OutboundApi->get_outbound_messagingcampaigns: %s\\n\" % e)"
+    "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.OutboundApi();\npage_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)\npage_number = 1 # int | Page number (optional) (default to 1)\nsort_by = ''name'' # str | The field to sort by (optional) (default to 'name')\nsort_order = ''ascending'' # str | The direction to sort (optional) (default to 'ascending')\nname = 'name_example' # str | Name (optional)\ncontact_list_id = 'contact_list_id_example' # str | Contact List ID (optional)\ndivision_id = ['division_id_example'] # list[str] | Division ID(s) (optional)\ntype = 'type_example' # str | Campaign Type (optional)\nsender_sms_phone_number = 'sender_sms_phone_number_example' # str | Sender SMS Phone Number (optional)\nid = ['id_example'] # list[str] | A list of messaging campaign ids to bulk fetch (optional)\ncontent_template_id = 'content_template_id_example' # str | Content template ID (optional)\ncampaign_status = 'campaign_status_example' # str | Campaign Status (optional)\nrule_set_ids = ['rule_set_ids_example'] # list[str] | Ruleset ID(s) (optional)\n\ntry:\n    # Query a list of Messaging Campaigns\n    api_response = api_instance.get_outbound_messagingcampaigns(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, contact_list_id=contact_list_id, division_id=division_id, type=type, sender_sms_phone_number=sender_sms_phone_number, id=id, content_template_id=content_template_id, campaign_status=campaign_status, rule_set_ids=rule_set_ids)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling OutboundApi->get_outbound_messagingcampaigns: %s\\n\" % e)"
   },
   "get_outbound_messagingcampaigns_divisionview": {
     "operationId": "get_outbound_messagingcampaigns_divisionview",

build/PureCloudPlatformClientV2/__init__.py

@@ -4113,6 +4113,7 @@
 from .models.recipient_request import RecipientRequest
 from .models.recognition import Recognition
 from .models.recognition_base import RecognitionBase
+from .models.recognitions import Recognitions
 from .models.record import Record
 from .models.recorders_state import RecordersState
 from .models.recording import Recording
@@ -4141,6 +4142,8 @@
 from .models.recording_job_failed_recording import RecordingJobFailedRecording
 from .models.recording_jobs_query import RecordingJobsQuery
 from .models.recording_location import RecordingLocation
+from .models.recording_message_receipt import RecordingMessageReceipt
+from .models.recording_message_receipt_reason import RecordingMessageReceiptReason
 from .models.recording_messaging_message import RecordingMessagingMessage
 from .models.recording_metadata import RecordingMetadata
 from .models.recording_notification_template import RecordingNotificationTemplate

build/PureCloudPlatformClientV2/api_client.py

@@ -419,7 +419,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'] = '244.0.0'
+        header_params['purecloud-sdk'] = '245.0.0'
 
         # path parameters
         if path_params:

build/PureCloudPlatformClientV2/apis/employee_engagement_api.py

@@ -41,6 +41,7 @@
 from ..models import GetCelebrationListing
 from ..models import Recognition
 from ..models import RecognitionBase
+from ..models import Recognitions
 
 class EmployeeEngagementApi(object):
     """
@@ -292,6 +293,96 @@ def get_employeeengagement_recognition(self, recognition_id: str, **kwargs) -> '
                                             callback=params.get('callback'))
         return response
 
+    def get_employeeengagement_recognitions(self, **kwargs) -> 'Recognitions':
+        """
+        Gets sent recognitions
+        
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.get_employeeengagement_recognitions(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str direction: The direction of the recognitions.
+        :param str recipient: The ID of the recipient (when direction is sent).
+        :param datetime date_start: The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
+        :param datetime date_end: The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
+        :param int page_size: Page size
+        :param int page_number: Page number
+        :return: Recognitions
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['direction', 'recipient', 'date_start', 'date_end', 'page_size', 'page_number']
+        all_params.append('callback')
+
+        params = locals()
+        for key, val in params['kwargs'].items():
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_employeeengagement_recognitions" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+
+
+        resource_path = '/api/v2/employeeengagement/recognitions'.replace('{format}', 'json')
+        path_params = {}
+
+        query_params = {}
+        if 'direction' in params:
+            query_params['direction'] = params['direction']
+        if 'recipient' in params:
+            query_params['recipient'] = params['recipient']
+        if 'date_start' in params:
+            query_params['dateStart'] = params['date_start']
+        if 'date_end' in params:
+            query_params['dateEnd'] = params['date_end']
+        if 'page_size' in params:
+            query_params['pageSize'] = params['page_size']
+        if 'page_number' in params:
+            query_params['pageNumber'] = params['page_number']
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/json'])
+        if not header_params['Accept']:
+            del header_params['Accept']
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.\
+            select_header_content_type(['application/json'])
+
+        # Authentication setting
+        auth_settings = ['PureCloud OAuth']
+
+        response = self.api_client.call_api(resource_path, 'GET',
+                                            path_params,
+                                            query_params,
+                                            header_params,
+                                            body=body_params,
+                                            post_params=form_params,
+                                            files=local_var_files,
+                                            response_type='Recognitions',
+                                            auth_settings=auth_settings,
+                                            callback=params.get('callback'))
+        return response
+
     def patch_employeeengagement_celebration(self, celebration_id: str, body: 'CelebrationStateParam', **kwargs) -> None:
         """
         Set a state for a celebration

build/PureCloudPlatformClientV2/apis/outbound_api.py

@@ -7224,12 +7224,13 @@ def get_outbound_messagingcampaigns(self, **kwargs) -> 'MessagingCampaignEntityL
         :param list[str] id: A list of messaging campaign ids to bulk fetch
         :param str content_template_id: Content template ID
         :param str campaign_status: Campaign Status
+        :param list[str] rule_set_ids: Ruleset ID(s)
         :return: MessagingCampaignEntityListing
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['page_size', 'page_number', 'sort_by', 'sort_order', 'name', 'contact_list_id', 'division_id', 'type', 'sender_sms_phone_number', 'id', 'content_template_id', 'campaign_status']
+        all_params = ['page_size', 'page_number', 'sort_by', 'sort_order', 'name', 'contact_list_id', 'division_id', 'type', 'sender_sms_phone_number', 'id', 'content_template_id', 'campaign_status', 'rule_set_ids']
         all_params.append('callback')
 
         params = locals()
@@ -7272,6 +7273,8 @@ def get_outbound_messagingcampaigns(self, **kwargs) -> 'MessagingCampaignEntityL
             query_params['contentTemplateId'] = params['content_template_id']
         if 'campaign_status' in params:
             query_params['campaignStatus'] = params['campaign_status']
+        if 'rule_set_ids' in params:
+            query_params['ruleSetIds'] = params['rule_set_ids']
 
         header_params = {}
 

build/PureCloudPlatformClientV2/configuration.py

@@ -256,7 +256,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v2\n"\
-               "SDK Package Version: 244.0.0".\
+               "SDK Package Version: 245.0.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def _update_config_from_file(self):

build/PureCloudPlatformClientV2/models/__init__.py

@@ -4113,6 +4113,7 @@
 from .recipient_request import RecipientRequest
 from .recognition import Recognition
 from .recognition_base import RecognitionBase
+from .recognitions import Recognitions
 from .record import Record
 from .recorders_state import RecordersState
 from .recording import Recording
@@ -4141,6 +4142,8 @@
 from .recording_job_failed_recording import RecordingJobFailedRecording
 from .recording_jobs_query import RecordingJobsQuery
 from .recording_location import RecordingLocation
+from .recording_message_receipt import RecordingMessageReceipt
+from .recording_message_receipt_reason import RecordingMessageReceiptReason
 from .recording_messaging_message import RecordingMessagingMessage
 from .recording_metadata import RecordingMetadata
 from .recording_notification_template import RecordingNotificationTemplate