Skip to content

Commit cc2f173

Browse files
author
PureCloud Jenkins
committed
188.0.0
1 parent 1f5fb70 commit cc2f173

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+1386
-171
lines changed

build/.openapi-generator/FILES

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,8 @@ PureCloudPlatformClientV2/models/callback_disconnect_identifier.py
557557
PureCloudPlatformClientV2/models/callback_identifier.py
558558
PureCloudPlatformClientV2/models/callback_media_participant.py
559559
PureCloudPlatformClientV2/models/callback_media_settings.py
560+
PureCloudPlatformClientV2/models/callheader.py
561+
PureCloudPlatformClientV2/models/callmessage.py
560562
PureCloudPlatformClientV2/models/campaign.py
561563
PureCloudPlatformClientV2/models/campaign_diagnostics.py
562564
PureCloudPlatformClientV2/models/campaign_division_view.py
@@ -1238,7 +1240,6 @@ PureCloudPlatformClientV2/models/digital_rule_set.py
12381240
PureCloudPlatformClientV2/models/digital_rule_set_entity_listing.py
12391241
PureCloudPlatformClientV2/models/digits.py
12401242
PureCloudPlatformClientV2/models/direct_routing.py
1241-
PureCloudPlatformClientV2/models/direct_routing_call_media_settings.py
12421243
PureCloudPlatformClientV2/models/direct_routing_media_settings.py
12431244
PureCloudPlatformClientV2/models/directory_user_devices_listing.py
12441245
PureCloudPlatformClientV2/models/disallowed_entity_learning_assignment_item.py
@@ -2223,6 +2224,7 @@ PureCloudPlatformClientV2/models/media_rtp_statistics.py
22232224
PureCloudPlatformClientV2/models/media_settings.py
22242225
PureCloudPlatformClientV2/models/media_statistics.py
22252226
PureCloudPlatformClientV2/models/media_statistics_listing.py
2227+
PureCloudPlatformClientV2/models/media_statistics_trunk_info.py
22262228
PureCloudPlatformClientV2/models/media_summary.py
22272229
PureCloudPlatformClientV2/models/media_summary_detail.py
22282230
PureCloudPlatformClientV2/models/media_transcription.py
@@ -4605,6 +4607,8 @@ docs/CallbackDisconnectIdentifier.md
46054607
docs/CallbackIdentifier.md
46064608
docs/CallbackMediaParticipant.md
46074609
docs/CallbackMediaSettings.md
4610+
docs/Callheader.md
4611+
docs/Callmessage.md
46084612
docs/Campaign.md
46094613
docs/CampaignDiagnostics.md
46104614
docs/CampaignDivisionView.md
@@ -5298,7 +5302,6 @@ docs/DigitalRuleSet.md
52985302
docs/DigitalRuleSetEntityListing.md
52995303
docs/Digits.md
53005304
docs/DirectRouting.md
5301-
docs/DirectRoutingCallMediaSettings.md
53025305
docs/DirectRoutingMediaSettings.md
53035306
docs/DirectoryUserDevicesListing.md
53045307
docs/DisallowedEntityLearningAssignmentItem.md
@@ -6325,6 +6328,7 @@ docs/MediaRtpStatistics.md
63256328
docs/MediaSettings.md
63266329
docs/MediaStatistics.md
63276330
docs/MediaStatisticsListing.md
6331+
docs/MediaStatisticsTrunkInfo.md
63286332
docs/MediaSummary.md
63296333
docs/MediaSummaryDetail.md
63306334
docs/MediaTranscription.md
@@ -9485,6 +9489,8 @@ docs/get_telephony_providers_edges_trunkbasesettings_template-example.txt
94859489
docs/get_telephony_providers_edges_trunks-example.txt
94869490
docs/get_telephony_providers_edges_trunks_metrics-example.txt
94879491
docs/get_telephony_providers_edges_trunkswithrecording-example.txt
9492+
docs/get_telephony_sipmessages_conversation-example.txt
9493+
docs/get_telephony_sipmessages_conversation_headers-example.txt
94889494
docs/get_telephony_siptraces-example.txt
94899495
docs/get_telephony_siptraces_download_download_id-example.txt
94909496
docs/get_textbots_bots_search-example.txt

build/APIData.json

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6478,11 +6478,11 @@
64786478
{
64796479
"name": "body",
64806480
"type": "CreateRoomRequest",
6481-
"required": "false"
6481+
"required": "true"
64826482
}
64836483
],
64846484
"return": "CreateRoomResponse",
6485-
"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(...) or get_code_authorization_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ChatApi();\nbody = PureCloudPlatformClientV2.CreateRoomRequest() # CreateRoomRequest | Room properties (optional)\n\ntry:\n # Create an adhoc room\n api_response = api_instance.post_chats_rooms(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ChatApi->post_chats_rooms: %s\\n\" % e)"
6485+
"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(...) or get_code_authorization_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ChatApi();\nbody = PureCloudPlatformClientV2.CreateRoomRequest() # CreateRoomRequest | Room properties\n\ntry:\n # Create an adhoc room\n api_response = api_instance.post_chats_rooms(body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ChatApi->post_chats_rooms: %s\\n\" % e)"
64866486
},
64876487
"post_chats_user_messages": {
64886488
"operationId": "post_chats_user_messages",
@@ -36062,6 +36062,39 @@
3606236062
"return": "MediaRegions",
3606336063
"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(...) or get_code_authorization_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.TelephonyApi();\n\ntry:\n # Retrieve the list of AWS regions media can stream through.\n api_response = api_instance.get_telephony_mediaregions()\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling TelephonyApi->get_telephony_mediaregions: %s\\n\" % e)"
3606436064
},
36065+
"get_telephony_sipmessages_conversation": {
36066+
"operationId": "get_telephony_sipmessages_conversation",
36067+
"functionName": "get_telephony_sipmessages_conversation",
36068+
"signature": "get_telephony_sipmessages_conversation(conversation_id)",
36069+
"parameters": [
36070+
{
36071+
"name": "conversation_id",
36072+
"type": "str",
36073+
"required": "true"
36074+
}
36075+
],
36076+
"return": "Callmessage",
36077+
"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(...) or get_code_authorization_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.TelephonyApi();\nconversation_id = 'conversation_id_example' # str | Conversation id\n\ntry:\n # Get a SIP message.\n api_response = api_instance.get_telephony_sipmessages_conversation(conversation_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling TelephonyApi->get_telephony_sipmessages_conversation: %s\\n\" % e)"
36078+
},
36079+
"get_telephony_sipmessages_conversation_headers": {
36080+
"operationId": "get_telephony_sipmessages_conversation_headers",
36081+
"functionName": "get_telephony_sipmessages_conversation_headers",
36082+
"signature": "get_telephony_sipmessages_conversation_headers(conversation_id, keys)",
36083+
"parameters": [
36084+
{
36085+
"name": "conversation_id",
36086+
"type": "str",
36087+
"required": "true"
36088+
},
36089+
{
36090+
"name": "keys",
36091+
"type": "list[str]",
36092+
"required": "false"
36093+
}
36094+
],
36095+
"return": "Callheader",
36096+
"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(...) or get_code_authorization_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.TelephonyApi();\nconversation_id = 'conversation_id_example' # str | Conversation id\nkeys = ['keys_example'] # list[str] | comma-separated list of header identifiers to query. e.g. ruri,to,from (optional)\n\ntry:\n # Get SIP headers.\n api_response = api_instance.get_telephony_sipmessages_conversation_headers(conversation_id, keys=keys)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling TelephonyApi->get_telephony_sipmessages_conversation_headers: %s\\n\" % e)"
36097+
},
3606536098
"get_telephony_siptraces": {
3606636099
"operationId": "get_telephony_siptraces",
3606736100
"functionName": "get_telephony_siptraces",

build/PureCloudPlatformClientV2/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,8 @@
481481
from .models.callback_identifier import CallbackIdentifier
482482
from .models.callback_media_participant import CallbackMediaParticipant
483483
from .models.callback_media_settings import CallbackMediaSettings
484+
from .models.callheader import Callheader
485+
from .models.callmessage import Callmessage
484486
from .models.campaign import Campaign
485487
from .models.campaign_diagnostics import CampaignDiagnostics
486488
from .models.campaign_division_view import CampaignDivisionView
@@ -1162,7 +1164,6 @@
11621164
from .models.digital_rule_set_entity_listing import DigitalRuleSetEntityListing
11631165
from .models.digits import Digits
11641166
from .models.direct_routing import DirectRouting
1165-
from .models.direct_routing_call_media_settings import DirectRoutingCallMediaSettings
11661167
from .models.direct_routing_media_settings import DirectRoutingMediaSettings
11671168
from .models.directory_user_devices_listing import DirectoryUserDevicesListing
11681169
from .models.disallowed_entity_learning_assignment_item import DisallowedEntityLearningAssignmentItem
@@ -2147,6 +2148,7 @@
21472148
from .models.media_settings import MediaSettings
21482149
from .models.media_statistics import MediaStatistics
21492150
from .models.media_statistics_listing import MediaStatisticsListing
2151+
from .models.media_statistics_trunk_info import MediaStatisticsTrunkInfo
21502152
from .models.media_summary import MediaSummary
21512153
from .models.media_summary_detail import MediaSummaryDetail
21522154
from .models.media_transcription import MediaTranscription

build/PureCloudPlatformClientV2/api_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ def __call_api(self, resource_path, method,
295295
header_params['Cookie'] = self.cookie
296296
if header_params:
297297
header_params = self.sanitize_for_serialization(header_params)
298-
header_params['purecloud-sdk'] = '187.3.0'
298+
header_params['purecloud-sdk'] = '188.0.0'
299299

300300
# path parameters
301301
if path_params:

build/PureCloudPlatformClientV2/apis/chat_api.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1876,7 +1876,7 @@ def post_chats_room_pinnedmessages(self, room_jid: str, body: 'PinnedMessageRequ
18761876
callback=params.get('callback'))
18771877
return response
18781878

1879-
def post_chats_rooms(self, **kwargs) -> 'CreateRoomResponse':
1879+
def post_chats_rooms(self, body: 'CreateRoomRequest', **kwargs) -> 'CreateRoomResponse':
18801880
"""
18811881
Create an adhoc room
18821882
@@ -1888,11 +1888,11 @@ def post_chats_rooms(self, **kwargs) -> 'CreateRoomResponse':
18881888
>>> def callback_function(response):
18891889
>>> pprint(response)
18901890
>>>
1891-
>>> thread = api.post_chats_rooms(callback=callback_function)
1891+
>>> thread = api.post_chats_rooms(body, callback=callback_function)
18921892
18931893
:param callback function: The callback function
18941894
for asynchronous request. (optional)
1895-
:param CreateRoomRequest body: Room properties
1895+
:param CreateRoomRequest body: Room properties (required)
18961896
:return: CreateRoomResponse
18971897
If the method is called asynchronously,
18981898
returns the request thread.
@@ -1911,6 +1911,9 @@ def post_chats_rooms(self, **kwargs) -> 'CreateRoomResponse':
19111911
params[key] = val
19121912
del params['kwargs']
19131913

1914+
# verify the required parameter 'body' is set
1915+
if ('body' not in params) or (params['body'] is None):
1916+
raise ValueError("Missing the required parameter `body` when calling `post_chats_rooms`")
19141917

19151918

19161919
resource_path = '/api/v2/chats/rooms'.replace('{format}', 'json')

build/PureCloudPlatformClientV2/apis/telephony_api.py

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
3838
from typing import Any
3939

4040
from ..models import Empty
41+
from ..models import Callheader
42+
from ..models import Callmessage
4143
from ..models import ErrorBody
4244
from ..models import MediaRegions
4345
from ..models import SIPSearchPublicRequest
@@ -133,6 +135,167 @@ def get_telephony_mediaregions(self, **kwargs) -> 'MediaRegions':
133135
callback=params.get('callback'))
134136
return response
135137

138+
def get_telephony_sipmessages_conversation(self, conversation_id: str, **kwargs) -> 'Callmessage':
139+
"""
140+
Get a SIP message.
141+
Get the raw form of the SIP message
142+
get_telephony_sipmessages_conversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
143+
144+
This method makes a synchronous HTTP request by default. To make an
145+
asynchronous HTTP request, please define a `callback` function
146+
to be invoked when receiving the response.
147+
>>> def callback_function(response):
148+
>>> pprint(response)
149+
>>>
150+
>>> thread = api.get_telephony_sipmessages_conversation(conversation_id, callback=callback_function)
151+
152+
:param callback function: The callback function
153+
for asynchronous request. (optional)
154+
:param str conversation_id: Conversation id (required)
155+
:return: Callmessage
156+
If the method is called asynchronously,
157+
returns the request thread.
158+
"""
159+
160+
all_params = ['conversation_id']
161+
all_params.append('callback')
162+
163+
params = locals()
164+
for key, val in iteritems(params['kwargs']):
165+
if key not in all_params:
166+
raise TypeError(
167+
"Got an unexpected keyword argument '%s'"
168+
" to method get_telephony_sipmessages_conversation" % key
169+
)
170+
params[key] = val
171+
del params['kwargs']
172+
173+
# verify the required parameter 'conversation_id' is set
174+
if ('conversation_id' not in params) or (params['conversation_id'] is None):
175+
raise ValueError("Missing the required parameter `conversation_id` when calling `get_telephony_sipmessages_conversation`")
176+
177+
178+
resource_path = '/api/v2/telephony/sipmessages/conversations/{conversationId}'.replace('{format}', 'json')
179+
path_params = {}
180+
if 'conversation_id' in params:
181+
path_params['conversationId'] = params['conversation_id']
182+
183+
query_params = {}
184+
185+
header_params = {}
186+
187+
form_params = []
188+
local_var_files = {}
189+
190+
body_params = None
191+
192+
# HTTP header `Accept`
193+
header_params['Accept'] = self.api_client.\
194+
select_header_accept(['application/json'])
195+
if not header_params['Accept']:
196+
del header_params['Accept']
197+
198+
# HTTP header `Content-Type`
199+
header_params['Content-Type'] = self.api_client.\
200+
select_header_content_type(['application/json'])
201+
202+
# Authentication setting
203+
auth_settings = ['PureCloud OAuth']
204+
205+
response = self.api_client.call_api(resource_path, 'GET',
206+
path_params,
207+
query_params,
208+
header_params,
209+
body=body_params,
210+
post_params=form_params,
211+
files=local_var_files,
212+
response_type='Callmessage',
213+
auth_settings=auth_settings,
214+
callback=params.get('callback'))
215+
return response
216+
217+
def get_telephony_sipmessages_conversation_headers(self, conversation_id: str, **kwargs) -> 'Callheader':
218+
"""
219+
Get SIP headers.
220+
Get parsed SIP headers. Returns specific headers if key query parameters are added.
221+
get_telephony_sipmessages_conversation_headers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
222+
223+
This method makes a synchronous HTTP request by default. To make an
224+
asynchronous HTTP request, please define a `callback` function
225+
to be invoked when receiving the response.
226+
>>> def callback_function(response):
227+
>>> pprint(response)
228+
>>>
229+
>>> thread = api.get_telephony_sipmessages_conversation_headers(conversation_id, callback=callback_function)
230+
231+
:param callback function: The callback function
232+
for asynchronous request. (optional)
233+
:param str conversation_id: Conversation id (required)
234+
:param list[str] keys: comma-separated list of header identifiers to query. e.g. ruri,to,from
235+
:return: Callheader
236+
If the method is called asynchronously,
237+
returns the request thread.
238+
"""
239+
240+
all_params = ['conversation_id', 'keys']
241+
all_params.append('callback')
242+
243+
params = locals()
244+
for key, val in iteritems(params['kwargs']):
245+
if key not in all_params:
246+
raise TypeError(
247+
"Got an unexpected keyword argument '%s'"
248+
" to method get_telephony_sipmessages_conversation_headers" % key
249+
)
250+
params[key] = val
251+
del params['kwargs']
252+
253+
# verify the required parameter 'conversation_id' is set
254+
if ('conversation_id' not in params) or (params['conversation_id'] is None):
255+
raise ValueError("Missing the required parameter `conversation_id` when calling `get_telephony_sipmessages_conversation_headers`")
256+
257+
258+
resource_path = '/api/v2/telephony/sipmessages/conversations/{conversationId}/headers'.replace('{format}', 'json')
259+
path_params = {}
260+
if 'conversation_id' in params:
261+
path_params['conversationId'] = params['conversation_id']
262+
263+
query_params = {}
264+
if 'keys' in params:
265+
query_params['keys'] = params['keys']
266+
267+
header_params = {}
268+
269+
form_params = []
270+
local_var_files = {}
271+
272+
body_params = None
273+
274+
# HTTP header `Accept`
275+
header_params['Accept'] = self.api_client.\
276+
select_header_accept(['application/json'])
277+
if not header_params['Accept']:
278+
del header_params['Accept']
279+
280+
# HTTP header `Content-Type`
281+
header_params['Content-Type'] = self.api_client.\
282+
select_header_content_type(['application/json'])
283+
284+
# Authentication setting
285+
auth_settings = ['PureCloud OAuth']
286+
287+
response = self.api_client.call_api(resource_path, 'GET',
288+
path_params,
289+
query_params,
290+
header_params,
291+
body=body_params,
292+
post_params=form_params,
293+
files=local_var_files,
294+
response_type='Callheader',
295+
auth_settings=auth_settings,
296+
callback=params.get('callback'))
297+
return response
298+
136299
def get_telephony_siptraces(self, date_start: datetime, date_end: datetime, **kwargs) -> 'SipSearchResult':
137300
"""
138301
Fetch SIP metadata

build/PureCloudPlatformClientV2/configuration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ def to_debug_report(self):
202202
"OS: {env}\n"\
203203
"Python Version: {pyversion}\n"\
204204
"Version of the API: v2\n"\
205-
"SDK Package Version: 187.3.0".\
205+
"SDK Package Version: 188.0.0".\
206206
format(env=sys.platform, pyversion=sys.version)
207207

208208
def _update_config_from_file(self):

0 commit comments

Comments
 (0)