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
|
@@ -133,7 +133,7 @@ Name | Type | Description | Notes
|
|
|
133
133
|
|
|
134
134
|
<a name="get_search"></a>
|
|
135
135
|
|
|
136
|
-
## -[**
|
|
136
|
+
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) get_search(opts)
|
|
137
137
|
|
|
138
138
|
Search using q64
|
|
139
139
|
|
|
@@ -181,7 +181,7 @@ Name | Type | Description | Notes
|
|
|
181
181
|
|
|
182
182
|
### Return type
|
|
183
183
|
|
|
184
|
-
[**
|
|
184
|
+
[**LocationsSearchResponse**](LocationsSearchResponse.html)
|
|
185
185
|
|
|
186
186
|
### HTTP request headers
|
|
187
187
|
|
|
@@ -192,7 +192,7 @@ Name | Type | Description | Notes
|
|
|
192
192
|
|
|
193
193
|
<a name="post_search"></a>
|
|
194
194
|
|
|
195
|
-
## -[**
|
|
195
|
+
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) post_search(opts)
|
|
196
196
|
|
|
197
197
|
Search
|
|
198
198
|
|
|
@@ -216,7 +216,7 @@ end
|
|
|
216
216
|
api_instance = PureCloud::LocationsApi.new
|
|
217
217
|
|
|
218
218
|
opts = {
|
|
219
|
-
body: PureCloud::
|
|
219
|
+
body: PureCloud::LocationSearchRequest.new # LocationSearchRequest | Search request options
|
|
220
220
|
}
|
|
221
221
|
|
|
222
222
|
begin
|
|
@@ -232,13 +232,13 @@ end
|
|
|
232
232
|
|
|
233
233
|
Name | Type | Description | Notes
|
|
234
234
|
------------- | ------------- | ------------- | -------------
|
|
235
|
-
**body** | [**
|
|
235
|
+
**body** | [**LocationSearchRequest**](LocationSearchRequest.html)| Search request options | [optional]
|
|
236
236
|
{: class="table table-striped"}
|
|
237
237
|
|
|
238
238
|
|
|
239
239
|
### Return type
|
|
240
240
|
|
|
241
|
-
[**
|
|
241
|
+
[**LocationsSearchResponse**](LocationsSearchResponse.html)
|
|
242
242
|
|
|
243
243
|
### HTTP request headers
|
|
244
244
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: LocationsSearchResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::LocationsSearchResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **total** | **Integer** | | [optional] |
|
|
11
|
+
| **page_count** | **Integer** | | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | | [optional] |
|
|
13
|
+
| **page_number** | **Integer** | | [optional] |
|
|
14
|
+
| **previous_page** | **String** | | [optional] |
|
|
15
|
+
| **current_page** | **String** | | [optional] |
|
|
16
|
+
| **next_page** | **String** | | [optional] |
|
|
17
|
+
| **types** | **Array<String>** | | [optional] |
|
|
18
|
+
| **results** | [**Array<Location>**](Location.html) | | [optional] |
|
|
19
|
+
| **aggregations** | [**Array<Location>**](Location.html) | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: NumberOrder
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::NumberOrder
|
|
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
|
+
| **did** | **String** | DID purchased | [optional] |
|
|
13
|
+
| **effective_start_date** | **DateTime** | Effective date of service for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
+
| **effective_end_date** | **DateTime** | Effective disconnection date for this order. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **last_updated** | **DateTime** | Date of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **start_auth_user_id** | **String** | UserId authorizing purchase | [optional] |
|
|
17
|
+
| **end_auth_user_id** | **String** | UserId authorizing disconnection | [optional] |
|
|
18
|
+
| **status** | **String** | Current status of this DID order | [optional] |
|
|
19
|
+
| **phone_number_type** | **String** | Class of DID being purchased (eg. us-domestic, toll-free, etc) | [optional] |
|
|
20
|
+
| **porting** | **BOOLEAN** | Whether or not the number was ported | [optional] [default to false]|
|
|
21
|
+
| **billing_address** | [**PortBillingAddress**](PortBillingAddress.html) | Billing address used for a number port | [optional] |
|
|
22
|
+
| **responsible_contact** | [**PortContact**](PortContact.html) | Company contact for a number port | [optional] |
|
|
23
|
+
| **company_name** | **String** | Company name for a number port | [optional] |
|
|
24
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
25
|
+
{: class="table table-striped"}
|
|
26
|
+
|
|
27
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: PortBillingAddress
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::PortBillingAddress
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **street_address** | **String** | | [optional] |
|
|
11
|
+
| **city_province** | **String** | | [optional] |
|
|
12
|
+
| **state** | **String** | | [optional] |
|
|
13
|
+
| **zip_postal** | **String** | | [optional] |
|
|
14
|
+
| **country** | **String** | | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: PortContact
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::PortContact
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **email** | **String** | | [optional] |
|
|
11
|
+
| **phone_number** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/doc_out/PresenceApi.html.md
CHANGED
|
@@ -304,7 +304,7 @@ Name | Type | Description | Notes
|
|
|
304
304
|
|
|
305
305
|
Patch a user's Presence
|
|
306
306
|
|
|
307
|
-
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.
|
|
307
|
+
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.
|
|
308
308
|
|
|
309
309
|
### Example
|
|
310
310
|
~~~ruby
|
|
@@ -11,7 +11,7 @@ title: QualityAudit
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **user** | [**User**](User.html) | | [optional] |
|
|
13
13
|
| **timestamp** | **String** | | [optional] |
|
|
14
|
-
| **entity** | [**
|
|
14
|
+
| **entity** | [**AuditEntity**](AuditEntity.html) | | [optional] |
|
|
15
15
|
| **level** | **String** | | [optional] |
|
|
16
16
|
| **action** | **String** | | [optional] |
|
|
17
17
|
| **status** | **String** | | [optional] |
|
|
@@ -287,7 +287,8 @@ api_instance = PureCloud::RecordingApi.new
|
|
|
287
287
|
conversation_id = "conversation_id_example" # String | Conversation ID
|
|
288
288
|
|
|
289
289
|
opts = {
|
|
290
|
-
|
|
290
|
+
max_wait_ms: 5000, # Integer | The maximum number of milliseconds to wait for the recording to be ready.
|
|
291
|
+
format_id: "WEBM" # String | The desired media format
|
|
291
292
|
}
|
|
292
293
|
|
|
293
294
|
begin
|
|
@@ -304,7 +305,8 @@ end
|
|
|
304
305
|
Name | Type | Description | Notes
|
|
305
306
|
------------- | ------------- | ------------- | -------------
|
|
306
307
|
**conversation_id** | **String**| Conversation ID |
|
|
307
|
-
**
|
|
308
|
+
**max_wait_ms** | **Integer**| The maximum number of milliseconds to wait for the recording to be ready. | [optional] [default to 5000]
|
|
309
|
+
**format_id** | **String**| The desired media format | [optional] [default to WEBM]
|
|
308
310
|
{: class="table table-striped"}
|
|
309
311
|
|
|
310
312
|
|
data/doc_out/ResponseSet.html.md
CHANGED
|
@@ -12,7 +12,7 @@ title: ResponseSet
|
|
|
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
|
-
| **responses** | [**Hash<String, Reaction>**](Reaction.html) | Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}} |
|
|
15
|
+
| **responses** | [**Hash<String, Reaction>**](Reaction.html) | Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}} | |
|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RoutingData
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RoutingData
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **queue_id** | **String** | | [optional] |
|
|
11
|
+
| **language_id** | **String** | | [optional] |
|
|
12
|
+
| **priority** | **Integer** | | [optional] |
|
|
13
|
+
| **skill_ids** | **Array<String>** | | [optional] |
|
|
14
|
+
| **preferred_agent_ids** | **Array<String>** | | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
data/doc_out/RuleSet.html.md
CHANGED
|
@@ -14,7 +14,7 @@ title: RuleSet
|
|
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
15
|
| **contact_list** | [**UriReference**](UriReference.html) | The identifier of an example contact list that provides user-interface suggestions for contact-based conditions and actions | [optional] |
|
|
16
16
|
| **queue** | [**UriReference**](UriReference.html) | The identifier of an example queue that provides user-interface suggestions for wrap-up associated conditions | [optional] |
|
|
17
|
-
| **rules** | [**Array<DialerRule>**](DialerRule.html) | The list of rules |
|
|
17
|
+
| **rules** | [**Array<DialerRule>**](DialerRule.html) | The list of rules | |
|
|
18
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
19
19
|
{: class="table table-striped"}
|
|
20
20
|
|
|
@@ -10,6 +10,9 @@ title: SearchAggregation
|
|
|
10
10
|
| **field** | **String** | | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **type** | **String** | | [optional] |
|
|
13
|
+
| **value** | **String** | | [optional] |
|
|
14
|
+
| **size** | **Integer** | | [optional] |
|
|
15
|
+
| **order** | **Array<String>** | | [optional] |
|
|
13
16
|
{: class="table table-striped"}
|
|
14
17
|
|
|
15
18
|
|
data/doc_out/SearchApi.html.md
CHANGED
|
@@ -81,7 +81,7 @@ Name | Type | Description | Notes
|
|
|
81
81
|
|
|
82
82
|
<a name="get_search_0"></a>
|
|
83
83
|
|
|
84
|
-
## -[**
|
|
84
|
+
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) get_search_0(opts)
|
|
85
85
|
|
|
86
86
|
Search using q64
|
|
87
87
|
|
|
@@ -129,7 +129,7 @@ Name | Type | Description | Notes
|
|
|
129
129
|
|
|
130
130
|
### Return type
|
|
131
131
|
|
|
132
|
-
[**
|
|
132
|
+
[**LocationsSearchResponse**](LocationsSearchResponse.html)
|
|
133
133
|
|
|
134
134
|
### HTTP request headers
|
|
135
135
|
|
|
@@ -343,7 +343,7 @@ end
|
|
|
343
343
|
api_instance = PureCloud::SearchApi.new
|
|
344
344
|
|
|
345
345
|
opts = {
|
|
346
|
-
body: PureCloud::
|
|
346
|
+
body: PureCloud::GroupSearchRequest.new # GroupSearchRequest | Search request options
|
|
347
347
|
}
|
|
348
348
|
|
|
349
349
|
begin
|
|
@@ -359,7 +359,7 @@ end
|
|
|
359
359
|
|
|
360
360
|
Name | Type | Description | Notes
|
|
361
361
|
------------- | ------------- | ------------- | -------------
|
|
362
|
-
**body** | [**
|
|
362
|
+
**body** | [**GroupSearchRequest**](GroupSearchRequest.html)| Search request options | [optional]
|
|
363
363
|
{: class="table table-striped"}
|
|
364
364
|
|
|
365
365
|
|
|
@@ -376,7 +376,7 @@ Name | Type | Description | Notes
|
|
|
376
376
|
|
|
377
377
|
<a name="post_search_0"></a>
|
|
378
378
|
|
|
379
|
-
## -[**
|
|
379
|
+
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) post_search_0(opts)
|
|
380
380
|
|
|
381
381
|
Search
|
|
382
382
|
|
|
@@ -400,7 +400,7 @@ end
|
|
|
400
400
|
api_instance = PureCloud::SearchApi.new
|
|
401
401
|
|
|
402
402
|
opts = {
|
|
403
|
-
body: PureCloud::
|
|
403
|
+
body: PureCloud::LocationSearchRequest.new # LocationSearchRequest | Search request options
|
|
404
404
|
}
|
|
405
405
|
|
|
406
406
|
begin
|
|
@@ -416,13 +416,13 @@ end
|
|
|
416
416
|
|
|
417
417
|
Name | Type | Description | Notes
|
|
418
418
|
------------- | ------------- | ------------- | -------------
|
|
419
|
-
**body** | [**
|
|
419
|
+
**body** | [**LocationSearchRequest**](LocationSearchRequest.html)| Search request options | [optional]
|
|
420
420
|
{: class="table table-striped"}
|
|
421
421
|
|
|
422
422
|
|
|
423
423
|
### Return type
|
|
424
424
|
|
|
425
|
-
[**
|
|
425
|
+
[**LocationsSearchResponse**](LocationsSearchResponse.html)
|
|
426
426
|
|
|
427
427
|
### HTTP request headers
|
|
428
428
|
|
|
@@ -516,7 +516,7 @@ end
|
|
|
516
516
|
api_instance = PureCloud::SearchApi.new
|
|
517
517
|
|
|
518
518
|
opts = {
|
|
519
|
-
body: PureCloud::
|
|
519
|
+
body: PureCloud::UserSearchRequest.new # UserSearchRequest | Search request options
|
|
520
520
|
}
|
|
521
521
|
|
|
522
522
|
begin
|
|
@@ -532,7 +532,7 @@ end
|
|
|
532
532
|
|
|
533
533
|
Name | Type | Description | Notes
|
|
534
534
|
------------- | ------------- | ------------- | -------------
|
|
535
|
-
**body** | [**
|
|
535
|
+
**body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options | [optional]
|
|
536
536
|
{: class="table table-striped"}
|
|
537
537
|
|
|
538
538
|
|
|
@@ -573,7 +573,7 @@ end
|
|
|
573
573
|
api_instance = PureCloud::SearchApi.new
|
|
574
574
|
|
|
575
575
|
opts = {
|
|
576
|
-
body: PureCloud::
|
|
576
|
+
body: PureCloud::SuggestSearchRequest.new, # SuggestSearchRequest | Search request options
|
|
577
577
|
profile: true # BOOLEAN |
|
|
578
578
|
}
|
|
579
579
|
|
|
@@ -590,7 +590,7 @@ end
|
|
|
590
590
|
|
|
591
591
|
Name | Type | Description | Notes
|
|
592
592
|
------------- | ------------- | ------------- | -------------
|
|
593
|
-
**body** | [**
|
|
593
|
+
**body** | [**SuggestSearchRequest**](SuggestSearchRequest.html)| Search request options | [optional]
|
|
594
594
|
**profile** | **BOOLEAN**| | [optional] [default to true]
|
|
595
595
|
{: class="table table-striped"}
|
|
596
596
|
|
|
@@ -10,11 +10,11 @@ title: SearchCriteria
|
|
|
10
10
|
| **end_value** | **String** | | [optional] |
|
|
11
11
|
| **values** | **Array<String>** | | [optional] |
|
|
12
12
|
| **start_value** | **String** | | [optional] |
|
|
13
|
-
| **type** | **String** | | [optional] |
|
|
14
13
|
| **fields** | **Array<String>** | | [optional] |
|
|
15
14
|
| **value** | **String** | | [optional] |
|
|
16
15
|
| **operator** | **String** | | [optional] |
|
|
17
16
|
| **group** | [**Array<SearchCriteria>**](SearchCriteria.html) | | [optional] |
|
|
17
|
+
| **type** | **String** | | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
|
19
19
|
|
|
20
20
|
|
|
@@ -7,15 +7,15 @@ title: SearchRequest
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **types** | **Array<String>** | | [optional] |
|
|
11
10
|
| **sort_order** | **String** | | [optional] |
|
|
12
|
-
| **query** | [**Array<SearchCriteria>**](SearchCriteria.html) | | [optional] |
|
|
13
11
|
| **sort_by** | **String** | | [optional] |
|
|
14
12
|
| **page_size** | **Integer** | | [optional] |
|
|
15
13
|
| **page_number** | **Integer** | | [optional] |
|
|
16
14
|
| **return_fields** | **Array<String>** | | [optional] |
|
|
17
|
-
| **aggregations** | [**Array<SearchAggregation>**](SearchAggregation.html) | | [optional] |
|
|
18
15
|
| **expand** | **Array<String>** | | [optional] |
|
|
16
|
+
| **types** | **Array<String>** | Resource Domain type | |
|
|
17
|
+
| **query** | [**Array<SearchCriteria>**](SearchCriteria.html) | | [optional] |
|
|
18
|
+
| **aggregations** | [**Array<SearchAggregation>**](SearchAggregation.html) | | [optional] |
|
|
19
19
|
{: class="table table-striped"}
|
|
20
20
|
|
|
21
21
|
|
data/doc_out/SuggestApi.html.md
CHANGED
|
@@ -219,7 +219,7 @@ end
|
|
|
219
219
|
api_instance = PureCloud::SuggestApi.new
|
|
220
220
|
|
|
221
221
|
opts = {
|
|
222
|
-
body: PureCloud::
|
|
222
|
+
body: PureCloud::SuggestSearchRequest.new, # SuggestSearchRequest | Search request options
|
|
223
223
|
profile: true # BOOLEAN |
|
|
224
224
|
}
|
|
225
225
|
|
|
@@ -236,7 +236,7 @@ end
|
|
|
236
236
|
|
|
237
237
|
Name | Type | Description | Notes
|
|
238
238
|
------------- | ------------- | ------------- | -------------
|
|
239
|
-
**body** | [**
|
|
239
|
+
**body** | [**SuggestSearchRequest**](SuggestSearchRequest.html)| Search request options | [optional]
|
|
240
240
|
**profile** | **BOOLEAN**| | [optional] [default to true]
|
|
241
241
|
{: class="table table-striped"}
|
|
242
242
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SuggestSearchCriteria
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SuggestSearchCriteria
|
|
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<SuggestSearchCriteria>**](SuggestSearchCriteria.html) | | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SuggestSearchRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SuggestSearchRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **types** | **Array<String>** | Resource Domain type | |
|
|
11
|
+
| **query** | [**Array<SuggestSearchCriteria>**](SuggestSearchCriteria.html) | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Usage
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::Usage
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **types** | [**Array<UsageItem>**](UsageItem.html) | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UsageItem
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UsageItem
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | | [optional] |
|
|
11
|
+
| **total_document_byte_count** | **Integer** | | [optional] |
|
|
12
|
+
| **total_document_count** | **Integer** | | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UserSearchCriteria
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UserSearchCriteria
|
|
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<UserSearchCriteria>**](UserSearchCriteria.html) | | [optional] |
|
|
17
|
+
| **type** | **String** | Search Type | |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UserSearchRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UserSearchRequest
|
|
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<UserSearchCriteria>**](UserSearchCriteria.html) | | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
data/doc_out/UsersApi.html.md
CHANGED
|
@@ -19,7 +19,6 @@ Method | HTTP request | Description
|
|
|
19
19
|
|[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user's CallForwarding|
|
|
20
20
|
|[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | **GET** /api/v2/users/{userId}/geolocations/{clientId} | Get a user's Geolocation|
|
|
21
21
|
|[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | **GET** /api/v2/users/{userId}/outofoffice | Get a OutOfOffice|
|
|
22
|
-
|[**get_user_id_profileskills**](UsersApi.html#get_user_id_profileskills) | **GET** /api/v2/users/{userId}/profileskills | List profile skills for a user|
|
|
23
22
|
|[**get_user_id_queues**](UsersApi.html#get_user_id_queues) | **GET** /api/v2/users/{userId}/queues | Get queues for user|
|
|
24
23
|
|[**get_user_id_roles**](UsersApi.html#get_user_id_roles) | **GET** /api/v2/users/{userId}/roles | Returns a listing of roles and permissions for a user.|
|
|
25
24
|
|[**get_user_id_routingskills**](UsersApi.html#get_user_id_routingskills) | **GET** /api/v2/users/{userId}/routingskills | List routing skills for user|
|
|
@@ -38,7 +37,6 @@ Method | HTTP request | Description
|
|
|
38
37
|
|[**post_users_observations_query**](UsersApi.html#post_users_observations_query) | **POST** /api/v2/analytics/users/observations/query | Query for user observations|
|
|
39
38
|
|[**put_user_id_callforwarding**](UsersApi.html#put_user_id_callforwarding) | **PUT** /api/v2/users/{userId}/callforwarding | Update a user's CallForwarding|
|
|
40
39
|
|[**put_user_id_outofoffice**](UsersApi.html#put_user_id_outofoffice) | **PUT** /api/v2/users/{userId}/outofoffice | Update an OutOfOffice|
|
|
41
|
-
|[**put_user_id_profileskills**](UsersApi.html#put_user_id_profileskills) | **PUT** /api/v2/users/{userId}/profileskills | Update profile skills for a user|
|
|
42
40
|
|[**put_user_id_roles**](UsersApi.html#put_user_id_roles) | **PUT** /api/v2/users/{userId}/roles | Sets the user's roles|
|
|
43
41
|
|[**put_user_id_routingskills_skill_id**](UsersApi.html#put_user_id_routingskills_skill_id) | **PUT** /api/v2/users/{userId}/routingskills/{skillId} | Update routing skill proficiency or state.|
|
|
44
42
|
|[**put_user_id_routingstatus**](UsersApi.html#put_user_id_routingstatus) | **PUT** /api/v2/users/{userId}/routingstatus | Update the routing status of a user|
|
|
@@ -673,62 +671,6 @@ Name | Type | Description | Notes
|
|
|
673
671
|
|
|
674
672
|
|
|
675
673
|
|
|
676
|
-
<a name="get_user_id_profileskills"></a>
|
|
677
|
-
|
|
678
|
-
## -Array<String>** get_user_id_profileskills(user_id)
|
|
679
|
-
|
|
680
|
-
List profile skills for a user
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
### Example
|
|
685
|
-
~~~ruby
|
|
686
|
-
# load the gem
|
|
687
|
-
require 'purecloud'
|
|
688
|
-
# setup authorization
|
|
689
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
690
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
691
|
-
environment = "mypurecloud.com"
|
|
692
|
-
|
|
693
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
694
|
-
|
|
695
|
-
PureCloud.configure do |config|
|
|
696
|
-
config.access_token = @authToken
|
|
697
|
-
end
|
|
698
|
-
|
|
699
|
-
api_instance = PureCloud::UsersApi.new
|
|
700
|
-
|
|
701
|
-
user_id = "user_id_example" # String | User ID
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
begin
|
|
705
|
-
#List profile skills for a user
|
|
706
|
-
result = api_instance.get_user_id_profileskills(user_id)
|
|
707
|
-
p result
|
|
708
|
-
rescue PureCloud::ApiError => e
|
|
709
|
-
puts "Exception when calling UsersApi->get_user_id_profileskills: #{e}"
|
|
710
|
-
end
|
|
711
|
-
~~~
|
|
712
|
-
|
|
713
|
-
### Parameters
|
|
714
|
-
|
|
715
|
-
Name | Type | Description | Notes
|
|
716
|
-
------------- | ------------- | ------------- | -------------
|
|
717
|
-
**user_id** | **String**| User ID |
|
|
718
|
-
{: class="table table-striped"}
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
### Return type
|
|
722
|
-
|
|
723
|
-
**Array<String>**
|
|
724
|
-
|
|
725
|
-
### HTTP request headers
|
|
726
|
-
|
|
727
|
-
- **Content-Type**: application/json
|
|
728
|
-
- **Accept**: application/json
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
674
|
<a name="get_user_id_queues"></a>
|
|
733
675
|
|
|
734
676
|
## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_id_queues(user_id, opts)
|
|
@@ -1420,7 +1362,7 @@ end
|
|
|
1420
1362
|
api_instance = PureCloud::UsersApi.new
|
|
1421
1363
|
|
|
1422
1364
|
opts = {
|
|
1423
|
-
body: PureCloud::
|
|
1365
|
+
body: PureCloud::UserSearchRequest.new # UserSearchRequest | Search request options
|
|
1424
1366
|
}
|
|
1425
1367
|
|
|
1426
1368
|
begin
|
|
@@ -1436,7 +1378,7 @@ end
|
|
|
1436
1378
|
|
|
1437
1379
|
Name | Type | Description | Notes
|
|
1438
1380
|
------------- | ------------- | ------------- | -------------
|
|
1439
|
-
**body** | [**
|
|
1381
|
+
**body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options | [optional]
|
|
1440
1382
|
{: class="table table-striped"}
|
|
1441
1383
|
|
|
1442
1384
|
|
|
@@ -1801,66 +1743,6 @@ Name | Type | Description | Notes
|
|
|
1801
1743
|
|
|
1802
1744
|
|
|
1803
1745
|
|
|
1804
|
-
<a name="put_user_id_profileskills"></a>
|
|
1805
|
-
|
|
1806
|
-
## -Array<String>** put_user_id_profileskills(user_id, opts)
|
|
1807
|
-
|
|
1808
|
-
Update profile skills for a user
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
### Example
|
|
1813
|
-
~~~ruby
|
|
1814
|
-
# load the gem
|
|
1815
|
-
require 'purecloud'
|
|
1816
|
-
# setup authorization
|
|
1817
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1818
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1819
|
-
environment = "mypurecloud.com"
|
|
1820
|
-
|
|
1821
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1822
|
-
|
|
1823
|
-
PureCloud.configure do |config|
|
|
1824
|
-
config.access_token = @authToken
|
|
1825
|
-
end
|
|
1826
|
-
|
|
1827
|
-
api_instance = PureCloud::UsersApi.new
|
|
1828
|
-
|
|
1829
|
-
user_id = "user_id_example" # String | User ID
|
|
1830
|
-
|
|
1831
|
-
opts = {
|
|
1832
|
-
body: [PureCloud::Array<String>.new] # Array<String> | Skills
|
|
1833
|
-
}
|
|
1834
|
-
|
|
1835
|
-
begin
|
|
1836
|
-
#Update profile skills for a user
|
|
1837
|
-
result = api_instance.put_user_id_profileskills(user_id, opts)
|
|
1838
|
-
p result
|
|
1839
|
-
rescue PureCloud::ApiError => e
|
|
1840
|
-
puts "Exception when calling UsersApi->put_user_id_profileskills: #{e}"
|
|
1841
|
-
end
|
|
1842
|
-
~~~
|
|
1843
|
-
|
|
1844
|
-
### Parameters
|
|
1845
|
-
|
|
1846
|
-
Name | Type | Description | Notes
|
|
1847
|
-
------------- | ------------- | ------------- | -------------
|
|
1848
|
-
**user_id** | **String**| User ID |
|
|
1849
|
-
**body** | **Array<String>**| Skills | [optional]
|
|
1850
|
-
{: class="table table-striped"}
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
### Return type
|
|
1854
|
-
|
|
1855
|
-
**Array<String>**
|
|
1856
|
-
|
|
1857
|
-
### HTTP request headers
|
|
1858
|
-
|
|
1859
|
-
- **Content-Type**: application/json
|
|
1860
|
-
- **Accept**: application/json
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
1746
|
<a name="put_user_id_roles"></a>
|
|
1865
1747
|
|
|
1866
1748
|
## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, opts)
|
|
@@ -16,6 +16,7 @@ title: UsersSearchResponse
|
|
|
16
16
|
| **next_page** | **String** | | [optional] |
|
|
17
17
|
| **types** | **Array<String>** | | [optional] |
|
|
18
18
|
| **results** | [**Array<User>**](User.html) | | [optional] |
|
|
19
|
+
| **aggregations** | [**Array<User>**](User.html) | | [optional] |
|
|
19
20
|
{: class="table table-striped"}
|
|
20
21
|
|
|
21
22
|
|