purecloud 0.40.1 → 0.41.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/AdditionalInfo.html.md +12 -0
- data/doc_out/{Entity.html.md → AuthzPerm.html.md} +3 -5
- data/doc_out/AuthzPermissionContext.html.md +1 -1
- data/doc_out/CallableTimeSet.html.md +1 -1
- data/doc_out/Callback.html.md +1 -0
- data/doc_out/CallbackIdentifier.html.md +14 -0
- data/doc_out/CallbackMediaParticipant.html.md +1 -0
- data/doc_out/ContentManagementApi.html.md +51 -0
- data/doc_out/ConversationsApi.html.md +120 -0
- data/doc_out/CreateCallbackCommand.html.md +2 -0
- data/doc_out/CreateCallbackResponse.html.md +14 -0
- data/doc_out/Dependency.html.md +1 -0
- data/doc_out/DependencyObject.html.md +1 -0
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +1 -1
- data/doc_out/GroupSearchCriteria.html.md +20 -0
- data/doc_out/GroupSearchRequest.html.md +19 -0
- data/doc_out/GroupsApi.html.md +2 -2
- data/doc_out/GroupsSearchResponse.html.md +1 -0
- data/doc_out/Integration.html.md +20 -0
- data/doc_out/IntegrationConfiguration.html.md +20 -0
- data/doc_out/{DeletedResourceConsumerEntityListing.html.md → IntegrationEntityListing.html.md} +3 -3
- data/doc_out/IntegrationStatusInfo.html.md +16 -0
- data/doc_out/IntegrationType.html.md +5 -3
- data/doc_out/JsonNode.html.md +1 -1
- data/doc_out/JsonNodeSearchResponse.html.md +1 -0
- data/doc_out/LocationSearchCriteria.html.md +20 -0
- data/doc_out/LocationSearchRequest.html.md +19 -0
- data/doc_out/LocationsApi.html.md +6 -6
- data/doc_out/LocationsSearchResponse.html.md +22 -0
- data/doc_out/NumberOrder.html.md +27 -0
- data/doc_out/PortBillingAddress.html.md +17 -0
- data/doc_out/PortContact.html.md +14 -0
- data/doc_out/PresenceApi.html.md +1 -1
- data/doc_out/QualityAudit.html.md +1 -1
- data/doc_out/RecordingApi.html.md +4 -2
- data/doc_out/ResponseSet.html.md +1 -1
- data/doc_out/RoutingData.html.md +17 -0
- data/doc_out/RuleSet.html.md +1 -1
- data/doc_out/SearchAggregation.html.md +3 -0
- data/doc_out/SearchApi.html.md +12 -12
- data/doc_out/SearchCriteria.html.md +1 -1
- data/doc_out/SearchRequest.html.md +3 -3
- data/doc_out/SuggestApi.html.md +2 -2
- data/doc_out/SuggestSearchCriteria.html.md +19 -0
- data/doc_out/SuggestSearchRequest.html.md +14 -0
- data/doc_out/Usage.html.md +13 -0
- data/doc_out/UsageItem.html.md +15 -0
- data/doc_out/UserSearchCriteria.html.md +20 -0
- data/doc_out/UserSearchRequest.html.md +19 -0
- data/doc_out/UsersApi.html.md +2 -120
- data/doc_out/UsersSearchResponse.html.md +1 -0
- data/doc_out/VoicemailMessageEntityListing.html.md +0 -7
- data/doc_out/Workspace.html.md +1 -0
- data/doc_out/WorkspaceCreate.html.md +1 -0
- data/doc_out/WorkspaceSummary.html.md +1 -0
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud/api/content_management_api.rb +55 -0
- data/lib/purecloud/api/conversations_api.rb +121 -0
- data/lib/purecloud/api/groups_api.rb +6 -6
- data/lib/purecloud/api/languages_api.rb +2 -2
- data/lib/purecloud/api/locations_api.rb +8 -8
- data/lib/purecloud/api/presence_api.rb +2 -2
- data/lib/purecloud/api/recording_api.rb +5 -2
- data/lib/purecloud/api/routing_api.rb +2 -2
- data/lib/purecloud/api/search_api.rb +14 -14
- data/lib/purecloud/api/suggest_api.rb +2 -2
- data/lib/purecloud/api/users_api.rb +6 -128
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/additional_info.rb +155 -0
- data/lib/purecloud/models/authz_perm.rb +177 -0
- data/lib/purecloud/models/authz_permission_context.rb +7 -7
- data/lib/purecloud/models/callback.rb +15 -4
- data/lib/purecloud/models/{entity.rb → callback_identifier.rb} +15 -24
- data/lib/purecloud/models/callback_media_participant.rb +15 -4
- data/lib/purecloud/models/contact.rb +1 -1
- data/lib/purecloud/models/create_callback_command.rb +24 -4
- data/lib/purecloud/models/create_callback_response.rb +179 -0
- data/lib/purecloud/models/dependency.rb +13 -1
- data/lib/purecloud/models/dependency_object.rb +13 -1
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +13 -13
- data/lib/purecloud/models/group_search_criteria.rb +260 -0
- data/lib/purecloud/models/group_search_request.rb +240 -0
- data/lib/purecloud/models/groups_search_response.rb +16 -4
- data/lib/purecloud/models/integration.rb +252 -0
- data/lib/purecloud/models/integration_configuration.rb +243 -0
- data/lib/purecloud/models/{deleted_resource_consumer_entity_listing.rb → integration_entity_listing.rb} +2 -2
- data/lib/purecloud/models/integration_status_info.rb +209 -0
- data/lib/purecloud/models/integration_type.rb +27 -1
- data/lib/purecloud/models/json_node.rb +13 -13
- data/lib/purecloud/models/json_node_search_response.rb +14 -4
- data/lib/purecloud/models/location_search_criteria.rb +260 -0
- data/lib/purecloud/models/location_search_request.rb +240 -0
- data/lib/purecloud/models/locations_search_response.rb +261 -0
- data/lib/purecloud/models/number_order.rb +339 -0
- data/lib/purecloud/models/number_order_request.rb +1 -1
- data/lib/purecloud/models/port_billing_address.rb +205 -0
- data/lib/purecloud/models/port_contact.rb +175 -0
- data/lib/purecloud/models/quality_audit.rb +1 -1
- data/lib/purecloud/models/reservation.rb +1 -1
- data/lib/purecloud/models/routing_data.rb +209 -0
- data/lib/purecloud/models/search_aggregation.rb +37 -5
- data/lib/purecloud/models/search_criteria.rb +22 -22
- data/lib/purecloud/models/search_request.rb +40 -39
- data/lib/purecloud/models/suggest_search_criteria.rb +240 -0
- data/lib/purecloud/models/suggest_search_request.rb +180 -0
- data/lib/purecloud/models/usage.rb +167 -0
- data/lib/purecloud/models/usage_item.rb +194 -0
- data/lib/purecloud/models/user_search_criteria.rb +260 -0
- data/lib/purecloud/models/user_search_request.rb +240 -0
- data/lib/purecloud/models/users_search_response.rb +16 -4
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +4 -74
- data/lib/purecloud/models/workspace.rb +11 -1
- data/lib/purecloud/models/workspace_create.rb +14 -4
- data/lib/purecloud/models/workspace_summary.rb +14 -4
- data/lib/purecloud/version.rb +1 -1
- data/lib/purecloud.rb +23 -2
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +48 -6
|
@@ -7,16 +7,9 @@ title: VoicemailMessageEntityListing
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **page_size** | **Integer** | | [optional] |
|
|
11
|
-
| **page_number** | **Integer** | | [optional] |
|
|
12
10
|
| **total** | **Integer** | | [optional] |
|
|
13
11
|
| **entities** | [**Array<VoicemailMessage>**](VoicemailMessage.html) | | [optional] |
|
|
14
12
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
|
-
| **last_uri** | **String** | | [optional] |
|
|
19
|
-
| **page_count** | **Integer** | | [optional] |
|
|
20
13
|
{: class="table table-striped"}
|
|
21
14
|
|
|
22
15
|
|
data/doc_out/Workspace.html.md
CHANGED
|
@@ -17,6 +17,7 @@ title: Workspace
|
|
|
17
17
|
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
18
18
|
| **summary** | [**WorkspaceSummary**](WorkspaceSummary.html) | | [optional] |
|
|
19
19
|
| **acl** | **Array<String>** | | [optional] |
|
|
20
|
+
| **description** | **String** | | [optional] |
|
|
20
21
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
22
|
{: class="table table-striped"}
|
|
22
23
|
|
|
@@ -9,6 +9,7 @@ title: WorkspaceCreate
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **name** | **String** | | [optional] |
|
|
11
11
|
| **bucket** | **String** | | [optional] |
|
|
12
|
+
| **description** | **String** | | [optional] |
|
|
12
13
|
{: class="table table-striped"}
|
|
13
14
|
|
|
14
15
|
|
|
@@ -8,6 +8,7 @@ title: WorkspaceSummary
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **total_document_count** | **Integer** | | [optional] |
|
|
11
|
+
| **total_document_byte_count** | **Integer** | | [optional] |
|
|
11
12
|
{: class="table table-striped"}
|
|
12
13
|
|
|
13
14
|
|
data/doc_out/index.html.md
CHANGED
|
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
|
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
10
10
|
|
|
11
11
|
- API version: v2
|
|
12
|
-
- Package version: 0.
|
|
13
|
-
- Build date: 2016-05-
|
|
12
|
+
- Package version: 0.41.1
|
|
13
|
+
- Build date: 2016-05-31T02:28:43.823Z
|
|
14
14
|
|
|
15
15
|
For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
|
|
|
18
18
|
|
|
19
19
|
### from rubygems.org
|
|
20
20
|
|
|
21
|
-
gem 'purecloud', '~> 0.
|
|
21
|
+
gem 'purecloud', '~> 0.41.1'
|
|
22
22
|
|
|
23
23
|
### Install from Git
|
|
24
24
|
|
|
@@ -1224,6 +1224,61 @@ module PureCloud
|
|
|
1224
1224
|
return data, status_code, headers
|
|
1225
1225
|
end
|
|
1226
1226
|
|
|
1227
|
+
# Get usage details.
|
|
1228
|
+
#
|
|
1229
|
+
# @param [Hash] opts the optional parameters
|
|
1230
|
+
# @return [Usage]
|
|
1231
|
+
def get_usage(opts = {})
|
|
1232
|
+
data, status_code, headers = get_usage_with_http_info(opts)
|
|
1233
|
+
return data
|
|
1234
|
+
end
|
|
1235
|
+
|
|
1236
|
+
# Get usage details.
|
|
1237
|
+
#
|
|
1238
|
+
# @param [Hash] opts the optional parameters
|
|
1239
|
+
# @return [Array<(Usage, Fixnum, Hash)>] Usage data, response status code and response headers
|
|
1240
|
+
def get_usage_with_http_info(opts = {})
|
|
1241
|
+
if @api_client.config.debugging
|
|
1242
|
+
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_usage ..."
|
|
1243
|
+
end
|
|
1244
|
+
|
|
1245
|
+
# resource path
|
|
1246
|
+
local_var_path = "/api/v2/contentmanagement/usage".sub('{format}','json')
|
|
1247
|
+
|
|
1248
|
+
# query parameters
|
|
1249
|
+
query_params = {}
|
|
1250
|
+
|
|
1251
|
+
# header parameters
|
|
1252
|
+
header_params = {}
|
|
1253
|
+
|
|
1254
|
+
# HTTP header 'Accept' (if needed)
|
|
1255
|
+
_header_accept = ['application/json']
|
|
1256
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1257
|
+
|
|
1258
|
+
# HTTP header 'Content-Type'
|
|
1259
|
+
_header_content_type = ['application/json']
|
|
1260
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1261
|
+
|
|
1262
|
+
# form parameters
|
|
1263
|
+
form_params = {}
|
|
1264
|
+
|
|
1265
|
+
# http body (model)
|
|
1266
|
+
post_body = nil
|
|
1267
|
+
|
|
1268
|
+
auth_names = ['PureCloud Auth']
|
|
1269
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1270
|
+
:header_params => header_params,
|
|
1271
|
+
:query_params => query_params,
|
|
1272
|
+
:form_params => form_params,
|
|
1273
|
+
:body => post_body,
|
|
1274
|
+
:auth_names => auth_names,
|
|
1275
|
+
:return_type => 'Usage')
|
|
1276
|
+
if @api_client.config.debugging
|
|
1277
|
+
@api_client.config.logger.debug "API called: ContentManagementApi#get_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1278
|
+
end
|
|
1279
|
+
return data, status_code, headers
|
|
1280
|
+
end
|
|
1281
|
+
|
|
1227
1282
|
# Get a list of workspaces.
|
|
1228
1283
|
# Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
|
|
1229
1284
|
# @param [Hash] opts the optional parameters
|
|
@@ -650,6 +650,70 @@ module PureCloud
|
|
|
650
650
|
return data, status_code, headers
|
|
651
651
|
end
|
|
652
652
|
|
|
653
|
+
# Get call history
|
|
654
|
+
#
|
|
655
|
+
# @param [Hash] opts the optional parameters
|
|
656
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
657
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
658
|
+
# @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
|
659
|
+
# @return [CallConversationEntityListing]
|
|
660
|
+
def get_calls_history(opts = {})
|
|
661
|
+
data, status_code, headers = get_calls_history_with_http_info(opts)
|
|
662
|
+
return data
|
|
663
|
+
end
|
|
664
|
+
|
|
665
|
+
# Get call history
|
|
666
|
+
#
|
|
667
|
+
# @param [Hash] opts the optional parameters
|
|
668
|
+
# @option opts [Integer] :page_size Page size
|
|
669
|
+
# @option opts [Integer] :page_number Page number
|
|
670
|
+
# @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
|
671
|
+
# @return [Array<(CallConversationEntityListing, Fixnum, Hash)>] CallConversationEntityListing data, response status code and response headers
|
|
672
|
+
def get_calls_history_with_http_info(opts = {})
|
|
673
|
+
if @api_client.config.debugging
|
|
674
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_calls_history ..."
|
|
675
|
+
end
|
|
676
|
+
|
|
677
|
+
# resource path
|
|
678
|
+
local_var_path = "/api/v2/conversations/calls/history".sub('{format}','json')
|
|
679
|
+
|
|
680
|
+
# query parameters
|
|
681
|
+
query_params = {}
|
|
682
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
683
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
684
|
+
query_params[:'interval'] = opts[:'interval'] if opts[:'interval']
|
|
685
|
+
|
|
686
|
+
# header parameters
|
|
687
|
+
header_params = {}
|
|
688
|
+
|
|
689
|
+
# HTTP header 'Accept' (if needed)
|
|
690
|
+
_header_accept = ['application/json']
|
|
691
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
692
|
+
|
|
693
|
+
# HTTP header 'Content-Type'
|
|
694
|
+
_header_content_type = ['application/json']
|
|
695
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
696
|
+
|
|
697
|
+
# form parameters
|
|
698
|
+
form_params = {}
|
|
699
|
+
|
|
700
|
+
# http body (model)
|
|
701
|
+
post_body = nil
|
|
702
|
+
|
|
703
|
+
auth_names = ['PureCloud Auth']
|
|
704
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
705
|
+
:header_params => header_params,
|
|
706
|
+
:query_params => query_params,
|
|
707
|
+
:form_params => form_params,
|
|
708
|
+
:body => post_body,
|
|
709
|
+
:auth_names => auth_names,
|
|
710
|
+
:return_type => 'CallConversationEntityListing')
|
|
711
|
+
if @api_client.config.debugging
|
|
712
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_calls_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
713
|
+
end
|
|
714
|
+
return data, status_code, headers
|
|
715
|
+
end
|
|
716
|
+
|
|
653
717
|
# Get the maximum number of participants that this user can have on a conference
|
|
654
718
|
#
|
|
655
719
|
# @param [Hash] opts the optional parameters
|
|
@@ -2486,6 +2550,63 @@ module PureCloud
|
|
|
2486
2550
|
return data, status_code, headers
|
|
2487
2551
|
end
|
|
2488
2552
|
|
|
2553
|
+
# Create a Callback
|
|
2554
|
+
#
|
|
2555
|
+
# @param [Hash] opts the optional parameters
|
|
2556
|
+
# @option opts [CreateCallbackCommand] :body
|
|
2557
|
+
# @return [CreateCallbackResponse]
|
|
2558
|
+
def post_callbacks(opts = {})
|
|
2559
|
+
data, status_code, headers = post_callbacks_with_http_info(opts)
|
|
2560
|
+
return data
|
|
2561
|
+
end
|
|
2562
|
+
|
|
2563
|
+
# Create a Callback
|
|
2564
|
+
#
|
|
2565
|
+
# @param [Hash] opts the optional parameters
|
|
2566
|
+
# @option opts [CreateCallbackCommand] :body
|
|
2567
|
+
# @return [Array<(CreateCallbackResponse, Fixnum, Hash)>] CreateCallbackResponse data, response status code and response headers
|
|
2568
|
+
def post_callbacks_with_http_info(opts = {})
|
|
2569
|
+
if @api_client.config.debugging
|
|
2570
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_callbacks ..."
|
|
2571
|
+
end
|
|
2572
|
+
|
|
2573
|
+
# resource path
|
|
2574
|
+
local_var_path = "/api/v2/conversations/callbacks".sub('{format}','json')
|
|
2575
|
+
|
|
2576
|
+
# query parameters
|
|
2577
|
+
query_params = {}
|
|
2578
|
+
|
|
2579
|
+
# header parameters
|
|
2580
|
+
header_params = {}
|
|
2581
|
+
|
|
2582
|
+
# HTTP header 'Accept' (if needed)
|
|
2583
|
+
_header_accept = ['application/json']
|
|
2584
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2585
|
+
|
|
2586
|
+
# HTTP header 'Content-Type'
|
|
2587
|
+
_header_content_type = ['application/json']
|
|
2588
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2589
|
+
|
|
2590
|
+
# form parameters
|
|
2591
|
+
form_params = {}
|
|
2592
|
+
|
|
2593
|
+
# http body (model)
|
|
2594
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
2595
|
+
|
|
2596
|
+
auth_names = ['PureCloud Auth']
|
|
2597
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
2598
|
+
:header_params => header_params,
|
|
2599
|
+
:query_params => query_params,
|
|
2600
|
+
:form_params => form_params,
|
|
2601
|
+
:body => post_body,
|
|
2602
|
+
:auth_names => auth_names,
|
|
2603
|
+
:return_type => 'CreateCallbackResponse')
|
|
2604
|
+
if @api_client.config.debugging
|
|
2605
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_callbacks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2606
|
+
end
|
|
2607
|
+
return data, status_code, headers
|
|
2608
|
+
end
|
|
2609
|
+
|
|
2489
2610
|
# Replace this participant with the specified user and/or address
|
|
2490
2611
|
#
|
|
2491
2612
|
# @param callback_id
|
|
@@ -178,8 +178,8 @@ module PureCloud
|
|
|
178
178
|
# verify the required parameter 'group_id' is set
|
|
179
179
|
fail "Missing the required parameter 'group_id' when calling get_group_id_members" if group_id.nil?
|
|
180
180
|
|
|
181
|
-
if opts[:'sort_order'] && !['
|
|
182
|
-
fail 'invalid value for "sort_order", must be one of
|
|
181
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
182
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
183
183
|
end
|
|
184
184
|
|
|
185
185
|
# resource path
|
|
@@ -246,8 +246,8 @@ module PureCloud
|
|
|
246
246
|
@api_client.config.logger.debug "Calling API: GroupsApi#get_groups ..."
|
|
247
247
|
end
|
|
248
248
|
|
|
249
|
-
if opts[:'sort_order'] && !['
|
|
250
|
-
fail 'invalid value for "sort_order", must be one of
|
|
249
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
250
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
251
251
|
end
|
|
252
252
|
|
|
253
253
|
# resource path
|
|
@@ -472,7 +472,7 @@ module PureCloud
|
|
|
472
472
|
# Search
|
|
473
473
|
#
|
|
474
474
|
# @param [Hash] opts the optional parameters
|
|
475
|
-
# @option opts [
|
|
475
|
+
# @option opts [GroupSearchRequest] :body Search request options
|
|
476
476
|
# @return [GroupsSearchResponse]
|
|
477
477
|
def post_search(opts = {})
|
|
478
478
|
data, status_code, headers = post_search_with_http_info(opts)
|
|
@@ -482,7 +482,7 @@ module PureCloud
|
|
|
482
482
|
# Search
|
|
483
483
|
#
|
|
484
484
|
# @param [Hash] opts the optional parameters
|
|
485
|
-
# @option opts [
|
|
485
|
+
# @option opts [GroupSearchRequest] :body Search request options
|
|
486
486
|
# @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
|
|
487
487
|
def post_search_with_http_info(opts = {})
|
|
488
488
|
if @api_client.config.debugging
|
|
@@ -167,8 +167,8 @@ module PureCloud
|
|
|
167
167
|
@api_client.config.logger.debug "Calling API: LanguagesApi#get_languages ..."
|
|
168
168
|
end
|
|
169
169
|
|
|
170
|
-
if opts[:'sort_order'] && !['
|
|
171
|
-
fail 'invalid value for "sort_order", must be one of
|
|
170
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
171
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
172
172
|
end
|
|
173
173
|
|
|
174
174
|
# resource path
|
|
@@ -157,7 +157,7 @@ module PureCloud
|
|
|
157
157
|
# @param [Hash] opts the optional parameters
|
|
158
158
|
# @option opts [String] :q64
|
|
159
159
|
# @option opts [Array<String>] :expand
|
|
160
|
-
# @return [
|
|
160
|
+
# @return [LocationsSearchResponse]
|
|
161
161
|
def get_search(opts = {})
|
|
162
162
|
data, status_code, headers = get_search_with_http_info(opts)
|
|
163
163
|
return data
|
|
@@ -168,7 +168,7 @@ module PureCloud
|
|
|
168
168
|
# @param [Hash] opts the optional parameters
|
|
169
169
|
# @option opts [String] :q64
|
|
170
170
|
# @option opts [Array<String>] :expand
|
|
171
|
-
# @return [Array<(
|
|
171
|
+
# @return [Array<(LocationsSearchResponse, Fixnum, Hash)>] LocationsSearchResponse data, response status code and response headers
|
|
172
172
|
def get_search_with_http_info(opts = {})
|
|
173
173
|
if @api_client.config.debugging
|
|
174
174
|
@api_client.config.logger.debug "Calling API: LocationsApi#get_search ..."
|
|
@@ -206,7 +206,7 @@ module PureCloud
|
|
|
206
206
|
:form_params => form_params,
|
|
207
207
|
:body => post_body,
|
|
208
208
|
:auth_names => auth_names,
|
|
209
|
-
:return_type => '
|
|
209
|
+
:return_type => 'LocationsSearchResponse')
|
|
210
210
|
if @api_client.config.debugging
|
|
211
211
|
@api_client.config.logger.debug "API called: LocationsApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
212
212
|
end
|
|
@@ -216,8 +216,8 @@ module PureCloud
|
|
|
216
216
|
# Search
|
|
217
217
|
#
|
|
218
218
|
# @param [Hash] opts the optional parameters
|
|
219
|
-
# @option opts [
|
|
220
|
-
# @return [
|
|
219
|
+
# @option opts [LocationSearchRequest] :body Search request options
|
|
220
|
+
# @return [LocationsSearchResponse]
|
|
221
221
|
def post_search(opts = {})
|
|
222
222
|
data, status_code, headers = post_search_with_http_info(opts)
|
|
223
223
|
return data
|
|
@@ -226,8 +226,8 @@ module PureCloud
|
|
|
226
226
|
# Search
|
|
227
227
|
#
|
|
228
228
|
# @param [Hash] opts the optional parameters
|
|
229
|
-
# @option opts [
|
|
230
|
-
# @return [Array<(
|
|
229
|
+
# @option opts [LocationSearchRequest] :body Search request options
|
|
230
|
+
# @return [Array<(LocationsSearchResponse, Fixnum, Hash)>] LocationsSearchResponse data, response status code and response headers
|
|
231
231
|
def post_search_with_http_info(opts = {})
|
|
232
232
|
if @api_client.config.debugging
|
|
233
233
|
@api_client.config.logger.debug "Calling API: LocationsApi#post_search ..."
|
|
@@ -263,7 +263,7 @@ module PureCloud
|
|
|
263
263
|
:form_params => form_params,
|
|
264
264
|
:body => post_body,
|
|
265
265
|
:auth_names => auth_names,
|
|
266
|
-
:return_type => '
|
|
266
|
+
:return_type => 'LocationsSearchResponse')
|
|
267
267
|
if @api_client.config.debugging
|
|
268
268
|
@api_client.config.logger.debug "API called: LocationsApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
269
269
|
end
|
|
@@ -326,7 +326,7 @@ module PureCloud
|
|
|
326
326
|
end
|
|
327
327
|
|
|
328
328
|
# Patch a user's Presence
|
|
329
|
-
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value.
|
|
329
|
+
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
330
330
|
# @param user_id user Id
|
|
331
331
|
# @param source_id Source
|
|
332
332
|
# @param [Hash] opts the optional parameters
|
|
@@ -338,7 +338,7 @@ module PureCloud
|
|
|
338
338
|
end
|
|
339
339
|
|
|
340
340
|
# Patch a user's Presence
|
|
341
|
-
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value.
|
|
341
|
+
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
342
342
|
# @param user_id user Id
|
|
343
343
|
# @param source_id Source
|
|
344
344
|
# @param [Hash] opts the optional parameters
|
|
@@ -278,7 +278,8 @@ module PureCloud
|
|
|
278
278
|
#
|
|
279
279
|
# @param conversation_id Conversation ID
|
|
280
280
|
# @param [Hash] opts the optional parameters
|
|
281
|
-
# @option opts [
|
|
281
|
+
# @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready. (default to 5000)
|
|
282
|
+
# @option opts [String] :format_id The desired media format (default to WEBM)
|
|
282
283
|
# @return [Array<Recording>]
|
|
283
284
|
def get_conversation_id_recordings(conversation_id, opts = {})
|
|
284
285
|
data, status_code, headers = get_conversation_id_recordings_with_http_info(conversation_id, opts)
|
|
@@ -289,7 +290,8 @@ module PureCloud
|
|
|
289
290
|
#
|
|
290
291
|
# @param conversation_id Conversation ID
|
|
291
292
|
# @param [Hash] opts the optional parameters
|
|
292
|
-
# @option opts [
|
|
293
|
+
# @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready.
|
|
294
|
+
# @option opts [String] :format_id The desired media format
|
|
293
295
|
# @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
|
|
294
296
|
def get_conversation_id_recordings_with_http_info(conversation_id, opts = {})
|
|
295
297
|
if @api_client.config.debugging
|
|
@@ -308,6 +310,7 @@ module PureCloud
|
|
|
308
310
|
|
|
309
311
|
# query parameters
|
|
310
312
|
query_params = {}
|
|
313
|
+
query_params[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms']
|
|
311
314
|
query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
|
|
312
315
|
|
|
313
316
|
# header parameters
|
|
@@ -1300,8 +1300,8 @@ module PureCloud
|
|
|
1300
1300
|
# verify the required parameter 'user_id' is set
|
|
1301
1301
|
fail "Missing the required parameter 'user_id' when calling get_user_id_routingskills" if user_id.nil?
|
|
1302
1302
|
|
|
1303
|
-
if opts[:'sort_order'] && !['
|
|
1304
|
-
fail 'invalid value for "sort_order", must be one of
|
|
1303
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
1304
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
1305
1305
|
end
|
|
1306
1306
|
|
|
1307
1307
|
# resource path
|
|
@@ -90,7 +90,7 @@ module PureCloud
|
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
91
|
# @option opts [String] :q64
|
|
92
92
|
# @option opts [Array<String>] :expand
|
|
93
|
-
# @return [
|
|
93
|
+
# @return [LocationsSearchResponse]
|
|
94
94
|
def get_search_0(opts = {})
|
|
95
95
|
data, status_code, headers = get_search_0_with_http_info(opts)
|
|
96
96
|
return data
|
|
@@ -101,7 +101,7 @@ module PureCloud
|
|
|
101
101
|
# @param [Hash] opts the optional parameters
|
|
102
102
|
# @option opts [String] :q64
|
|
103
103
|
# @option opts [Array<String>] :expand
|
|
104
|
-
# @return [Array<(
|
|
104
|
+
# @return [Array<(LocationsSearchResponse, Fixnum, Hash)>] LocationsSearchResponse data, response status code and response headers
|
|
105
105
|
def get_search_0_with_http_info(opts = {})
|
|
106
106
|
if @api_client.config.debugging
|
|
107
107
|
@api_client.config.logger.debug "Calling API: SearchApi#get_search_0 ..."
|
|
@@ -139,7 +139,7 @@ module PureCloud
|
|
|
139
139
|
:form_params => form_params,
|
|
140
140
|
:body => post_body,
|
|
141
141
|
:auth_names => auth_names,
|
|
142
|
-
:return_type => '
|
|
142
|
+
:return_type => 'LocationsSearchResponse')
|
|
143
143
|
if @api_client.config.debugging
|
|
144
144
|
@api_client.config.logger.debug "API called: SearchApi#get_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
145
145
|
end
|
|
@@ -335,7 +335,7 @@ module PureCloud
|
|
|
335
335
|
# Search
|
|
336
336
|
#
|
|
337
337
|
# @param [Hash] opts the optional parameters
|
|
338
|
-
# @option opts [
|
|
338
|
+
# @option opts [GroupSearchRequest] :body Search request options
|
|
339
339
|
# @return [GroupsSearchResponse]
|
|
340
340
|
def post_search(opts = {})
|
|
341
341
|
data, status_code, headers = post_search_with_http_info(opts)
|
|
@@ -345,7 +345,7 @@ module PureCloud
|
|
|
345
345
|
# Search
|
|
346
346
|
#
|
|
347
347
|
# @param [Hash] opts the optional parameters
|
|
348
|
-
# @option opts [
|
|
348
|
+
# @option opts [GroupSearchRequest] :body Search request options
|
|
349
349
|
# @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
|
|
350
350
|
def post_search_with_http_info(opts = {})
|
|
351
351
|
if @api_client.config.debugging
|
|
@@ -392,8 +392,8 @@ module PureCloud
|
|
|
392
392
|
# Search
|
|
393
393
|
#
|
|
394
394
|
# @param [Hash] opts the optional parameters
|
|
395
|
-
# @option opts [
|
|
396
|
-
# @return [
|
|
395
|
+
# @option opts [LocationSearchRequest] :body Search request options
|
|
396
|
+
# @return [LocationsSearchResponse]
|
|
397
397
|
def post_search_0(opts = {})
|
|
398
398
|
data, status_code, headers = post_search_0_with_http_info(opts)
|
|
399
399
|
return data
|
|
@@ -402,8 +402,8 @@ module PureCloud
|
|
|
402
402
|
# Search
|
|
403
403
|
#
|
|
404
404
|
# @param [Hash] opts the optional parameters
|
|
405
|
-
# @option opts [
|
|
406
|
-
# @return [Array<(
|
|
405
|
+
# @option opts [LocationSearchRequest] :body Search request options
|
|
406
|
+
# @return [Array<(LocationsSearchResponse, Fixnum, Hash)>] LocationsSearchResponse data, response status code and response headers
|
|
407
407
|
def post_search_0_with_http_info(opts = {})
|
|
408
408
|
if @api_client.config.debugging
|
|
409
409
|
@api_client.config.logger.debug "Calling API: SearchApi#post_search_0 ..."
|
|
@@ -439,7 +439,7 @@ module PureCloud
|
|
|
439
439
|
:form_params => form_params,
|
|
440
440
|
:body => post_body,
|
|
441
441
|
:auth_names => auth_names,
|
|
442
|
-
:return_type => '
|
|
442
|
+
:return_type => 'LocationsSearchResponse')
|
|
443
443
|
if @api_client.config.debugging
|
|
444
444
|
@api_client.config.logger.debug "API called: SearchApi#post_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
445
445
|
end
|
|
@@ -509,7 +509,7 @@ module PureCloud
|
|
|
509
509
|
# Search
|
|
510
510
|
#
|
|
511
511
|
# @param [Hash] opts the optional parameters
|
|
512
|
-
# @option opts [
|
|
512
|
+
# @option opts [UserSearchRequest] :body Search request options
|
|
513
513
|
# @return [UsersSearchResponse]
|
|
514
514
|
def post_search_2(opts = {})
|
|
515
515
|
data, status_code, headers = post_search_2_with_http_info(opts)
|
|
@@ -519,7 +519,7 @@ module PureCloud
|
|
|
519
519
|
# Search
|
|
520
520
|
#
|
|
521
521
|
# @param [Hash] opts the optional parameters
|
|
522
|
-
# @option opts [
|
|
522
|
+
# @option opts [UserSearchRequest] :body Search request options
|
|
523
523
|
# @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
|
|
524
524
|
def post_search_2_with_http_info(opts = {})
|
|
525
525
|
if @api_client.config.debugging
|
|
@@ -566,7 +566,7 @@ module PureCloud
|
|
|
566
566
|
# Suggest
|
|
567
567
|
#
|
|
568
568
|
# @param [Hash] opts the optional parameters
|
|
569
|
-
# @option opts [
|
|
569
|
+
# @option opts [SuggestSearchRequest] :body Search request options
|
|
570
570
|
# @option opts [BOOLEAN] :profile (default to true)
|
|
571
571
|
# @return [JsonNodeSearchResponse]
|
|
572
572
|
def post_suggest(opts = {})
|
|
@@ -577,7 +577,7 @@ module PureCloud
|
|
|
577
577
|
# Suggest
|
|
578
578
|
#
|
|
579
579
|
# @param [Hash] opts the optional parameters
|
|
580
|
-
# @option opts [
|
|
580
|
+
# @option opts [SuggestSearchRequest] :body Search request options
|
|
581
581
|
# @option opts [BOOLEAN] :profile
|
|
582
582
|
# @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
|
|
583
583
|
def post_suggest_with_http_info(opts = {})
|
|
@@ -212,7 +212,7 @@ module PureCloud
|
|
|
212
212
|
# Suggest
|
|
213
213
|
#
|
|
214
214
|
# @param [Hash] opts the optional parameters
|
|
215
|
-
# @option opts [
|
|
215
|
+
# @option opts [SuggestSearchRequest] :body Search request options
|
|
216
216
|
# @option opts [BOOLEAN] :profile (default to true)
|
|
217
217
|
# @return [JsonNodeSearchResponse]
|
|
218
218
|
def post_suggest(opts = {})
|
|
@@ -223,7 +223,7 @@ module PureCloud
|
|
|
223
223
|
# Suggest
|
|
224
224
|
#
|
|
225
225
|
# @param [Hash] opts the optional parameters
|
|
226
|
-
# @option opts [
|
|
226
|
+
# @option opts [SuggestSearchRequest] :body Search request options
|
|
227
227
|
# @option opts [BOOLEAN] :profile
|
|
228
228
|
# @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
|
|
229
229
|
def post_suggest_with_http_info(opts = {})
|