purecloud 0.40.1 → 0.41.1
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 436a2a8469fc9b946bc51096ab299f647af66f2b
|
4
|
+
data.tar.gz: 9410ddd0df5409a9bd69174a865938be7ceb9a60
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ad359681b414d4f71d82b58bd86a66da88fa6a7b7d84bf9028e2a9a77cf3853a22392061aabdde0997ea60effe87544c5f47bb6108e0c446f96cbbd671876cee
|
7
|
+
data.tar.gz: 99ff4f6fd2dfc32b4cb516af6885c7bc4408e0047dd88efba2e940b74f223bac24995de1d79aabed07748cd0f3defc220a659d8ed260e31e8ec8e2746901a0fb
|
data/README.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
|
|
data/config-ruby.json
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"gemVersion":"0.
|
1
|
+
{"gemVersion":"0.41.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.41.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
|
@@ -1,16 +1,14 @@
|
|
1
1
|
---
|
2
|
-
title:
|
2
|
+
title: AuthzPerm
|
3
3
|
---
|
4
|
-
## PureCloud::
|
4
|
+
## PureCloud::AuthzPerm
|
5
5
|
|
6
6
|
## Properties
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **type** | **String** | | [optional] |
|
11
|
-
| **id** | **String** | | [optional] |
|
12
10
|
| **name** | **String** | | [optional] |
|
13
|
-
| **
|
11
|
+
| **permitted** | **BOOLEAN** | | [optional] [default to false]|
|
14
12
|
{: class="table table-striped"}
|
15
13
|
|
16
14
|
|
@@ -7,7 +7,7 @@ title: AuthzPermissionContext
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **
|
10
|
+
| **id** | **String** | | [optional] |
|
11
11
|
| **type** | **String** | | [optional] |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
@@ -12,7 +12,7 @@ title: CallableTimeSet
|
|
12
12
|
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
13
|
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
15
|
-
| **callable_times** | [**Array<CallableTime>**](CallableTime.html) | list of time/timezone groupings for which it is acceptable to place outbound calls |
|
15
|
+
| **callable_times** | [**Array<CallableTime>**](CallableTime.html) | list of time/timezone groupings for which it is acceptable to place outbound calls | |
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
data/doc_out/Callback.html.md
CHANGED
@@ -22,6 +22,7 @@ title: Callback
|
|
22
22
|
| **timeout_seconds** | **Integer** | | [optional] |
|
23
23
|
| **connected_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
24
24
|
| **disconnected_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
25
|
+
| **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
25
26
|
{: class="table table-striped"}
|
26
27
|
|
27
28
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: CallbackIdentifier
|
3
|
+
---
|
4
|
+
## PureCloud::CallbackIdentifier
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | The type of the associated callback participant | |
|
11
|
+
| **id** | **String** | The identifier of the callback | |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -33,6 +33,7 @@ title: CallbackMediaParticipant
|
|
33
33
|
| **callback_user_name** | **String** | | [optional] |
|
34
34
|
| **skip_enabled** | **BOOLEAN** | | [optional] [default to false]|
|
35
35
|
| **timeout_seconds** | **Integer** | | [optional] |
|
36
|
+
| **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
36
37
|
{: class="table table-striped"}
|
37
38
|
|
38
39
|
|
@@ -26,6 +26,7 @@ Method | HTTP request | Description
|
|
26
26
|
|[**get_shares_share_id**](ContentManagementApi.html#get_shares_share_id) | **GET** /api/v2/contentmanagement/shares/{shareId} | Retrieve details about an existing share.|
|
27
27
|
|[**get_status**](ContentManagementApi.html#get_status) | **GET** /api/v2/contentmanagement/status | Get a list of statuses for pending operations|
|
28
28
|
|[**get_status_status_id**](ContentManagementApi.html#get_status_status_id) | **GET** /api/v2/contentmanagement/status/{statusId} | Get a status.|
|
29
|
+
|[**get_usage**](ContentManagementApi.html#get_usage) | **GET** /api/v2/contentmanagement/usage | Get usage details.|
|
29
30
|
|[**get_workspaces**](ContentManagementApi.html#get_workspaces) | **GET** /api/v2/contentmanagement/workspaces | Get a list of workspaces.|
|
30
31
|
|[**get_workspaces_workspace_id**](ContentManagementApi.html#get_workspaces_workspace_id) | **GET** /api/v2/contentmanagement/workspaces/{workspaceId} | Get a workspace.|
|
31
32
|
|[**get_workspaces_workspace_id_members**](ContentManagementApi.html#get_workspaces_workspace_id_members) | **GET** /api/v2/contentmanagement/workspaces/{workspaceId}/members | Get a list workspace members|
|
@@ -1128,6 +1129,56 @@ Name | Type | Description | Notes
|
|
1128
1129
|
|
1129
1130
|
|
1130
1131
|
|
1132
|
+
<a name="get_usage"></a>
|
1133
|
+
|
1134
|
+
## -[**Usage**](Usage.html) get_usage
|
1135
|
+
|
1136
|
+
Get usage details.
|
1137
|
+
|
1138
|
+
|
1139
|
+
|
1140
|
+
### Example
|
1141
|
+
~~~ruby
|
1142
|
+
# load the gem
|
1143
|
+
require 'purecloud'
|
1144
|
+
# setup authorization
|
1145
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1146
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1147
|
+
environment = "mypurecloud.com"
|
1148
|
+
|
1149
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1150
|
+
|
1151
|
+
PureCloud.configure do |config|
|
1152
|
+
config.access_token = @authToken
|
1153
|
+
end
|
1154
|
+
|
1155
|
+
api_instance = PureCloud::ContentManagementApi.new
|
1156
|
+
|
1157
|
+
begin
|
1158
|
+
#Get usage details.
|
1159
|
+
result = api_instance.get_usage
|
1160
|
+
p result
|
1161
|
+
rescue PureCloud::ApiError => e
|
1162
|
+
puts "Exception when calling ContentManagementApi->get_usage: #{e}"
|
1163
|
+
end
|
1164
|
+
~~~
|
1165
|
+
|
1166
|
+
### Parameters
|
1167
|
+
This endpoint does not need any parameter.
|
1168
|
+
{: class="table table-striped"}
|
1169
|
+
|
1170
|
+
|
1171
|
+
### Return type
|
1172
|
+
|
1173
|
+
[**Usage**](Usage.html)
|
1174
|
+
|
1175
|
+
### HTTP request headers
|
1176
|
+
|
1177
|
+
- **Content-Type**: application/json
|
1178
|
+
- **Accept**: application/json
|
1179
|
+
|
1180
|
+
|
1181
|
+
|
1131
1182
|
<a name="get_workspaces"></a>
|
1132
1183
|
|
1133
1184
|
## -[**WorkspaceEntityListing**](WorkspaceEntityListing.html) get_workspaces(opts)
|
@@ -18,6 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
|[**get_calls_call_id**](ConversationsApi.html#get_calls_call_id) | **GET** /api/v2/conversations/calls/{callId} | Get call conversation|
|
19
19
|
|[**get_calls_call_id_participants_participant_id_wrapup**](ConversationsApi.html#get_calls_call_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|
20
20
|
|[**get_calls_call_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_calls_call_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|
21
|
+
|[**get_calls_history**](ConversationsApi.html#get_calls_history) | **GET** /api/v2/conversations/calls/history | Get call history|
|
21
22
|
|[**get_calls_maximumconferenceparties**](ConversationsApi.html#get_calls_maximumconferenceparties) | **GET** /api/v2/conversations/calls/maximumconferenceparties | Get the maximum number of participants that this user can have on a conference|
|
22
23
|
|[**get_chats**](ConversationsApi.html#get_chats) | **GET** /api/v2/conversations/chats | Get recent chat conversations|
|
23
24
|
|[**get_chats_chat_id**](ConversationsApi.html#get_chats_chat_id) | **GET** /api/v2/conversations/chats/{chatId} | Get chat conversation|
|
@@ -47,6 +48,7 @@ Method | HTTP request | Description
|
|
47
48
|
|[**patch_conversation_id_participants_participant_id_attributes**](ConversationsApi.html#patch_conversation_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/{conversationId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
48
49
|
|[**patch_emails_email_id_participants_participant_id**](ConversationsApi.html#patch_emails_email_id_participants_participant_id) | **PATCH** /api/v2/conversations/emails/{emailId}/participants/{participantId} | Update conversation participant|
|
49
50
|
|[**patch_emails_email_id_participants_participant_id_attributes**](ConversationsApi.html#patch_emails_email_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/emails/{emailId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
51
|
+
|[**post_callbacks**](ConversationsApi.html#post_callbacks) | **POST** /api/v2/conversations/callbacks | Create a Callback|
|
50
52
|
|[**post_callbacks_callback_id_participants_participant_id_replace**](ConversationsApi.html#post_callbacks_callback_id_participants_participant_id_replace) | **POST** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|
51
53
|
|[**post_calls**](ConversationsApi.html#post_calls) | **POST** /api/v2/conversations/calls | Create a call conversation|
|
52
54
|
|[**post_calls_call_id**](ConversationsApi.html#post_calls_call_id) | **POST** /api/v2/conversations/calls/{callId} | Add a new call to a conversation|
|
@@ -640,6 +642,67 @@ Name | Type | Description | Notes
|
|
640
642
|
|
641
643
|
|
642
644
|
|
645
|
+
<a name="get_calls_history"></a>
|
646
|
+
|
647
|
+
## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_calls_history(opts)
|
648
|
+
|
649
|
+
Get call history
|
650
|
+
|
651
|
+
|
652
|
+
|
653
|
+
### Example
|
654
|
+
~~~ruby
|
655
|
+
# load the gem
|
656
|
+
require 'purecloud'
|
657
|
+
# setup authorization
|
658
|
+
@secret = ENV['PURECLOUD_SECRET']
|
659
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
660
|
+
environment = "mypurecloud.com"
|
661
|
+
|
662
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
663
|
+
|
664
|
+
PureCloud.configure do |config|
|
665
|
+
config.access_token = @authToken
|
666
|
+
end
|
667
|
+
|
668
|
+
api_instance = PureCloud::ConversationsApi.new
|
669
|
+
|
670
|
+
opts = {
|
671
|
+
page_size: 25, # Integer | Page size
|
672
|
+
page_number: 1, # Integer | Page number
|
673
|
+
interval: "interval_example" # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
674
|
+
}
|
675
|
+
|
676
|
+
begin
|
677
|
+
#Get call history
|
678
|
+
result = api_instance.get_calls_history(opts)
|
679
|
+
p result
|
680
|
+
rescue PureCloud::ApiError => e
|
681
|
+
puts "Exception when calling ConversationsApi->get_calls_history: #{e}"
|
682
|
+
end
|
683
|
+
~~~
|
684
|
+
|
685
|
+
### Parameters
|
686
|
+
|
687
|
+
Name | Type | Description | Notes
|
688
|
+
------------- | ------------- | ------------- | -------------
|
689
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
690
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
691
|
+
**interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash '/' | [optional]
|
692
|
+
{: class="table table-striped"}
|
693
|
+
|
694
|
+
|
695
|
+
### Return type
|
696
|
+
|
697
|
+
[**CallConversationEntityListing**](CallConversationEntityListing.html)
|
698
|
+
|
699
|
+
### HTTP request headers
|
700
|
+
|
701
|
+
- **Content-Type**: application/json
|
702
|
+
- **Accept**: application/json
|
703
|
+
|
704
|
+
|
705
|
+
|
643
706
|
<a name="get_calls_maximumconferenceparties"></a>
|
644
707
|
|
645
708
|
## -[**MaxParticipants**](MaxParticipants.html) get_calls_maximumconferenceparties
|
@@ -2351,6 +2414,63 @@ nil (empty response body)
|
|
2351
2414
|
|
2352
2415
|
|
2353
2416
|
|
2417
|
+
<a name="post_callbacks"></a>
|
2418
|
+
|
2419
|
+
## -[**CreateCallbackResponse**](CreateCallbackResponse.html) post_callbacks(opts)
|
2420
|
+
|
2421
|
+
Create a Callback
|
2422
|
+
|
2423
|
+
|
2424
|
+
|
2425
|
+
### Example
|
2426
|
+
~~~ruby
|
2427
|
+
# load the gem
|
2428
|
+
require 'purecloud'
|
2429
|
+
# setup authorization
|
2430
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2431
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2432
|
+
environment = "mypurecloud.com"
|
2433
|
+
|
2434
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2435
|
+
|
2436
|
+
PureCloud.configure do |config|
|
2437
|
+
config.access_token = @authToken
|
2438
|
+
end
|
2439
|
+
|
2440
|
+
api_instance = PureCloud::ConversationsApi.new
|
2441
|
+
|
2442
|
+
opts = {
|
2443
|
+
body: PureCloud::CreateCallbackCommand.new # CreateCallbackCommand |
|
2444
|
+
}
|
2445
|
+
|
2446
|
+
begin
|
2447
|
+
#Create a Callback
|
2448
|
+
result = api_instance.post_callbacks(opts)
|
2449
|
+
p result
|
2450
|
+
rescue PureCloud::ApiError => e
|
2451
|
+
puts "Exception when calling ConversationsApi->post_callbacks: #{e}"
|
2452
|
+
end
|
2453
|
+
~~~
|
2454
|
+
|
2455
|
+
### Parameters
|
2456
|
+
|
2457
|
+
Name | Type | Description | Notes
|
2458
|
+
------------- | ------------- | ------------- | -------------
|
2459
|
+
**body** | [**CreateCallbackCommand**](CreateCallbackCommand.html)| | [optional]
|
2460
|
+
{: class="table table-striped"}
|
2461
|
+
|
2462
|
+
|
2463
|
+
### Return type
|
2464
|
+
|
2465
|
+
[**CreateCallbackResponse**](CreateCallbackResponse.html)
|
2466
|
+
|
2467
|
+
### HTTP request headers
|
2468
|
+
|
2469
|
+
- **Content-Type**: application/json
|
2470
|
+
- **Accept**: application/json
|
2471
|
+
|
2472
|
+
|
2473
|
+
|
2354
2474
|
<a name="post_callbacks_callback_id_participants_participant_id_replace"></a>
|
2355
2475
|
|
2356
2476
|
## - post_callbacks_callback_id_participants_participant_id_replace(callback_id, participant_id, opts)
|
@@ -9,11 +9,13 @@ title: CreateCallbackCommand
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **script_id** | **String** | | [optional] |
|
11
11
|
| **queue_id** | **String** | | [optional] |
|
12
|
+
| **routing_data** | [**RoutingData**](RoutingData.html) | | [optional] |
|
12
13
|
| **callback_user_name** | **String** | | [optional] |
|
13
14
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
14
15
|
| **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
15
16
|
| **country_code** | **String** | | [optional] |
|
16
17
|
| **skip_enabled** | **BOOLEAN** | | [optional] [default to false]|
|
18
|
+
| **additional_info** | [**AdditionalInfo**](AdditionalInfo.html) | | [optional] |
|
17
19
|
{: class="table table-striped"}
|
18
20
|
|
19
21
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: CreateCallbackResponse
|
3
|
+
---
|
4
|
+
## PureCloud::CreateCallbackResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **conversation** | [**UriReference**](UriReference.html) | The conversation associated with the callback | |
|
11
|
+
| **callback_identifiers** | [**Array<CallbackIdentifier>**](CallbackIdentifier.html) | The list of communication identifiers for the callback participants | |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
data/doc_out/Dependency.html.md
CHANGED
@@ -12,6 +12,7 @@ title: Dependency
|
|
12
12
|
| **version** | **String** | | [optional] |
|
13
13
|
| **type** | **String** | | [optional] |
|
14
14
|
| **deleted** | **BOOLEAN** | | [optional] [default to false]|
|
15
|
+
| **updated** | **BOOLEAN** | | [optional] [default to false]|
|
15
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
16
17
|
{: class="table table-striped"}
|
17
18
|
|
@@ -12,6 +12,7 @@ title: DependencyObject
|
|
12
12
|
| **version** | **String** | | [optional] |
|
13
13
|
| **type** | **String** | | [optional] |
|
14
14
|
| **deleted** | **BOOLEAN** | | [optional] [default to false]|
|
15
|
+
| **updated** | **BOOLEAN** | | [optional] [default to false]|
|
15
16
|
| **consumed_resources** | [**Array<Dependency>**](Dependency.html) | | [optional] |
|
16
17
|
| **consuming_resources** | [**Array<Dependency>**](Dependency.html) | | [optional] |
|
17
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
@@ -12,8 +12,8 @@ title: DomainEdgeSoftwareVersionDto
|
|
12
12
|
| **edge_version** | **String** | | [optional] |
|
13
13
|
| **publish_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
14
|
| **edge_uri** | **String** | | [optional] |
|
15
|
-
| **current** | **BOOLEAN** | | [optional] [default to false]|
|
16
15
|
| **latest_release** | **BOOLEAN** | | [optional] [default to false]|
|
16
|
+
| **current** | **BOOLEAN** | | [optional] [default to false]|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
18
|
{: class="table table-striped"}
|
19
19
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
title: GroupSearchCriteria
|
3
|
+
---
|
4
|
+
## PureCloud::GroupSearchCriteria
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **end_value** | **String** | | [optional] |
|
11
|
+
| **values** | **Array<String>** | | [optional] |
|
12
|
+
| **start_value** | **String** | | [optional] |
|
13
|
+
| **fields** | **Array<String>** | | [optional] |
|
14
|
+
| **value** | **String** | | [optional] |
|
15
|
+
| **operator** | **String** | | [optional] |
|
16
|
+
| **group** | [**Array<GroupSearchCriteria>**](GroupSearchCriteria.html) | | [optional] |
|
17
|
+
| **type** | **String** | Search Type | |
|
18
|
+
{: class="table table-striped"}
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
---
|
2
|
+
title: GroupSearchRequest
|
3
|
+
---
|
4
|
+
## PureCloud::GroupSearchRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **sort_order** | **String** | | [optional] |
|
11
|
+
| **sort_by** | **String** | | [optional] |
|
12
|
+
| **page_size** | **Integer** | | [optional] |
|
13
|
+
| **page_number** | **Integer** | | [optional] |
|
14
|
+
| **return_fields** | **Array<String>** | | [optional] |
|
15
|
+
| **expand** | **Array<String>** | | [optional] |
|
16
|
+
| **query** | [**Array<GroupSearchCriteria>**](GroupSearchCriteria.html) | | [optional] |
|
17
|
+
{: class="table table-striped"}
|
18
|
+
|
19
|
+
|
data/doc_out/GroupsApi.html.md
CHANGED
@@ -458,7 +458,7 @@ end
|
|
458
458
|
api_instance = PureCloud::GroupsApi.new
|
459
459
|
|
460
460
|
opts = {
|
461
|
-
body: PureCloud::
|
461
|
+
body: PureCloud::GroupSearchRequest.new # GroupSearchRequest | Search request options
|
462
462
|
}
|
463
463
|
|
464
464
|
begin
|
@@ -474,7 +474,7 @@ end
|
|
474
474
|
|
475
475
|
Name | Type | Description | Notes
|
476
476
|
------------- | ------------- | ------------- | -------------
|
477
|
-
**body** | [**
|
477
|
+
**body** | [**GroupSearchRequest**](GroupSearchRequest.html)| Search request options | [optional]
|
478
478
|
{: class="table table-striped"}
|
479
479
|
|
480
480
|
|
@@ -16,6 +16,7 @@ title: GroupsSearchResponse
|
|
16
16
|
| **next_page** | **String** | | [optional] |
|
17
17
|
| **types** | **Array<String>** | | [optional] |
|
18
18
|
| **results** | [**Array<Group>**](Group.html) | | [optional] |
|
19
|
+
| **aggregations** | [**Array<Group>**](Group.html) | | [optional] |
|
19
20
|
{: class="table table-striped"}
|
20
21
|
|
21
22
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
title: Integration
|
3
|
+
---
|
4
|
+
## PureCloud::Integration
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **integration_type** | [**IntegrationType**](IntegrationType.html) | Type of the integration. | |
|
13
|
+
| **state** | **String** | Configured state of the integration. | [optional] |
|
14
|
+
| **config** | [**IntegrationConfiguration**](IntegrationConfiguration.html) | Configuration for the integration. | [optional] |
|
15
|
+
| **last_status** | [**IntegrationStatusInfo**](IntegrationStatusInfo.html) | Last reported status of the integration. | [optional] |
|
16
|
+
| **version** | **Integer** | Version number required for updates. | [optional] |
|
17
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
|
+
{: class="table table-striped"}
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
title: IntegrationConfiguration
|
3
|
+
---
|
4
|
+
## PureCloud::IntegrationConfiguration
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **version** | **Integer** | Version number required for updates. | [optional] |
|
13
|
+
| **properties_schema_uri** | **String** | URI for the JSON Schema describing the configuration properties in the properties field. | [optional] |
|
14
|
+
| **advanced_schema_uri** | **String** | URI for the JSON Schema describing the advanced configuration | [optional] |
|
15
|
+
| **properties** | **Object** | Key-value configuration settings described by the schema in the propertiesSchemaUri field. | [optional] |
|
16
|
+
| **advanced** | **Object** | Advanced configuration described by the schema in the advancedSchemaUri field. | [optional] |
|
17
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
|
+
{: class="table table-striped"}
|
19
|
+
|
20
|
+
|
data/doc_out/{DeletedResourceConsumerEntityListing.html.md → IntegrationEntityListing.html.md}
RENAMED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
title:
|
2
|
+
title: IntegrationEntityListing
|
3
3
|
---
|
4
|
-
## PureCloud::
|
4
|
+
## PureCloud::IntegrationEntityListing
|
5
5
|
|
6
6
|
## Properties
|
7
7
|
|
@@ -10,7 +10,7 @@ title: DeletedResourceConsumerEntityListing
|
|
10
10
|
| **page_size** | **Integer** | | [optional] |
|
11
11
|
| **page_number** | **Integer** | | [optional] |
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
|
-
| **entities** | [**Array<
|
13
|
+
| **entities** | [**Array<Integration>**](Integration.html) | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: IntegrationStatusInfo
|
3
|
+
---
|
4
|
+
## PureCloud::IntegrationStatusInfo
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **internal** | **String** | Machine-readable status as reported by the integration. | |
|
11
|
+
| **effective** | **String** | Localized, human-readable, effective status of the integration. | |
|
12
|
+
| **detail** | **String** | Localized status details for the integration. | [optional] |
|
13
|
+
| **last_updated** | **DateTime** | Date and time (in UTC) when the integration status (i.e. the internal field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -9,9 +9,11 @@ title: IntegrationType
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
-
| **description** | **String** |
|
13
|
-
| **provider** | **String** |
|
14
|
-
| **images** | [**Array<UserImage>**](UserImage.html) |
|
12
|
+
| **description** | **String** | Localized description of the integration type. | |
|
13
|
+
| **provider** | **String** | PureCloud provider of the integration type. | |
|
14
|
+
| **images** | [**Array<UserImage>**](UserImage.html) | Collection of logos. | |
|
15
|
+
| **config_properties_schema_uri** | **String** | URI of the schema describing the key-value properties needed to configure an integration of this type. | [optional] |
|
16
|
+
| **config_advanced_schema_uri** | **String** | URI of the schema describing the advanced JSON document needed to configure an integration of this type. | [optional] |
|
15
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
16
18
|
{: class="table table-striped"}
|
17
19
|
|
data/doc_out/JsonNode.html.md
CHANGED
@@ -16,6 +16,7 @@ title: JsonNode
|
|
16
16
|
| **missing_node** | **BOOLEAN** | | [optional] [default to false]|
|
17
17
|
| **pojo** | **BOOLEAN** | | [optional] [default to false]|
|
18
18
|
| **integral_number** | **BOOLEAN** | | [optional] [default to false]|
|
19
|
+
| **floating_point_number** | **BOOLEAN** | | [optional] [default to false]|
|
19
20
|
| **short** | **BOOLEAN** | | [optional] [default to false]|
|
20
21
|
| **int** | **BOOLEAN** | | [optional] [default to false]|
|
21
22
|
| **long** | **BOOLEAN** | | [optional] [default to false]|
|
@@ -25,7 +26,6 @@ title: JsonNode
|
|
25
26
|
| **textual** | **BOOLEAN** | | [optional] [default to false]|
|
26
27
|
| **binary** | **BOOLEAN** | | [optional] [default to false]|
|
27
28
|
| **value_node** | **BOOLEAN** | | [optional] [default to false]|
|
28
|
-
| **floating_point_number** | **BOOLEAN** | | [optional] [default to false]|
|
29
29
|
| **array** | **BOOLEAN** | | [optional] [default to false]|
|
30
30
|
| **null** | **BOOLEAN** | | [optional] [default to false]|
|
31
31
|
{: class="table table-striped"}
|
@@ -16,6 +16,7 @@ title: JsonNodeSearchResponse
|
|
16
16
|
| **next_page** | **String** | | [optional] |
|
17
17
|
| **types** | **Array<String>** | | [optional] |
|
18
18
|
| **results** | [**JsonNode**](JsonNode.html) | | [optional] |
|
19
|
+
| **aggregations** | [**JsonNode**](JsonNode.html) | | [optional] |
|
19
20
|
{: class="table table-striped"}
|
20
21
|
|
21
22
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
title: LocationSearchCriteria
|
3
|
+
---
|
4
|
+
## PureCloud::LocationSearchCriteria
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **end_value** | **String** | | [optional] |
|
11
|
+
| **values** | **Array<String>** | | [optional] |
|
12
|
+
| **start_value** | **String** | | [optional] |
|
13
|
+
| **fields** | **Array<String>** | | [optional] |
|
14
|
+
| **value** | **String** | | [optional] |
|
15
|
+
| **operator** | **String** | | [optional] |
|
16
|
+
| **group** | [**Array<LocationSearchCriteria>**](LocationSearchCriteria.html) | | [optional] |
|
17
|
+
| **type** | **String** | Search Type | |
|
18
|
+
{: class="table table-striped"}
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
---
|
2
|
+
title: LocationSearchRequest
|
3
|
+
---
|
4
|
+
## PureCloud::LocationSearchRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **sort_order** | **String** | | [optional] |
|
11
|
+
| **sort_by** | **String** | | [optional] |
|
12
|
+
| **page_size** | **Integer** | | [optional] |
|
13
|
+
| **page_number** | **Integer** | | [optional] |
|
14
|
+
| **return_fields** | **Array<String>** | | [optional] |
|
15
|
+
| **expand** | **Array<String>** | | [optional] |
|
16
|
+
| **query** | [**Array<LocationSearchCriteria>**](LocationSearchCriteria.html) | | [optional] |
|
17
|
+
{: class="table table-striped"}
|
18
|
+
|
19
|
+
|