purecloud 0.62.1 → 0.63.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/ADFS.html.md +1 -1
- data/doc_out/AggregationQuery.html.md +1 -1
- data/doc_out/AnalyticsConversationSegment.html.md +3 -3
- data/doc_out/AnalyticsSession.html.md +2 -2
- data/doc_out/AttributesApi.html.md +29 -29
- data/doc_out/AuditMessage.html.md +1 -1
- data/doc_out/Call.html.md +4 -4
- data/doc_out/CallForwarding.html.md +1 -1
- data/doc_out/CallMediaParticipant.html.md +6 -6
- data/doc_out/Callback.html.md +2 -2
- data/doc_out/CallbackMediaParticipant.html.md +4 -4
- data/doc_out/Campaign.html.md +1 -1
- data/doc_out/CampaignInteraction.html.md +1 -1
- data/doc_out/CampaignRule.html.md +2 -2
- data/doc_out/CampaignRuleActionEntities.html.md +1 -1
- data/doc_out/CampaignSequence.html.md +1 -1
- data/doc_out/CertificateDetails.html.md +3 -3
- data/doc_out/ChatMediaParticipant.html.md +3 -3
- data/doc_out/CobrowseMediaParticipant.html.md +3 -3
- data/doc_out/Condition.html.md +1 -1
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ContentQueryRequest.html.md +1 -1
- data/doc_out/ContentSortItem.html.md +1 -1
- data/doc_out/ConversationChat.html.md +1 -1
- data/doc_out/ConversationsApi.html.md +58 -58
- data/doc_out/CustomerInteractionCenter.html.md +1 -1
- data/doc_out/DialerContact.html.md +1 -1
- data/doc_out/Document.html.md +1 -1
- data/doc_out/DocumentAudit.html.md +1 -1
- data/doc_out/DocumentUpdate.html.md +1 -1
- data/doc_out/DomainCapabilities.html.md +4 -4
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +2 -2
- data/doc_out/DomainLogicalInterface.html.md +3 -3
- data/doc_out/DomainNetworkAddress.html.md +1 -1
- data/doc_out/DomainNetworkCommandResponse.html.md +1 -1
- data/doc_out/DomainNetworkRoute.html.md +1 -1
- data/doc_out/DomainOrganizationRole.html.md +3 -3
- data/doc_out/DomainOrganizationRoleCreate.html.md +3 -3
- data/doc_out/DomainOrganizationRoleUpdate.html.md +3 -3
- data/doc_out/DomainPermission.html.md +1 -1
- data/doc_out/DomainPermissionPolicy.html.md +1 -1
- data/doc_out/DomainPhysicalCapabilities.html.md +2 -2
- data/doc_out/Edge.html.md +2 -2
- data/doc_out/EdgeAutoUpdateConfig.html.md +2 -2
- data/doc_out/EdgeGroup.html.md +1 -1
- data/doc_out/EdgeLogsJobRequest.html.md +1 -1
- data/doc_out/Email.html.md +1 -1
- data/doc_out/EmailMediaParticipant.html.md +3 -3
- data/doc_out/Endpoint.html.md +1 -1
- data/doc_out/Evaluation.html.md +4 -4
- data/doc_out/EvaluationForm.html.md +1 -1
- data/doc_out/EvaluationScoringSet.html.md +1 -1
- data/doc_out/FaxDocument.html.md +1 -1
- data/doc_out/FieldList.html.md +3 -3
- data/doc_out/Geolocation.html.md +1 -1
- data/doc_out/GeolocationSettings.html.md +1 -1
- data/doc_out/GreetingsApi.html.md +50 -50
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupUpdate.html.md +1 -1
- data/doc_out/GroupsApi.html.md +68 -68
- data/doc_out/HeartBeatRule.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +22 -22
- data/doc_out/InboundDomain.html.md +1 -1
- data/doc_out/InitiateScreenRecording.html.md +1 -1
- data/doc_out/InteractionStatsAlert.html.md +1 -1
- data/doc_out/InteractionStatsRule.html.md +2 -2
- data/doc_out/JsonNode.html.md +20 -20
- data/doc_out/LineStatus.html.md +1 -1
- data/doc_out/LocationDefinition.html.md +1 -1
- data/doc_out/MediaParticipantRequest.html.md +5 -5
- data/doc_out/MeteredEvaluationAssignment.html.md +1 -1
- data/doc_out/OAuthProvider.html.md +1 -1
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrgMediaUtilization.html.md +1 -1
- data/doc_out/Organization.html.md +1 -1
- data/doc_out/OrganizationPresence.html.md +2 -2
- data/doc_out/OutOfOffice.html.md +1 -1
- data/doc_out/OutboundRoute.html.md +2 -2
- data/doc_out/Parameter.html.md +1 -1
- data/doc_out/Participant.html.md +2 -2
- data/doc_out/PhoneCapabilities.html.md +5 -5
- data/doc_out/PhoneNumberStatus.html.md +1 -1
- data/doc_out/Policy.html.md +1 -1
- data/doc_out/PolicyActions.html.md +3 -3
- data/doc_out/PolicyCreate.html.md +1 -1
- data/doc_out/PresenceApi.html.md +33 -33
- data/doc_out/PureCloud.html.md +1 -1
- data/doc_out/QualityAudit.html.md +1 -1
- data/doc_out/QueryRequest.html.md +1 -1
- data/doc_out/QuestionGroup.html.md +4 -4
- data/doc_out/QuestionGroupScore.html.md +1 -1
- data/doc_out/QuestionScore.html.md +2 -2
- data/doc_out/QueueMember.html.md +1 -1
- data/doc_out/RecordingApi.html.md +70 -70
- data/doc_out/ReportSchedule.html.md +1 -1
- data/doc_out/ResourcePermissionPolicy.html.md +1 -1
- data/doc_out/RoutingStatusRule.html.md +2 -2
- data/doc_out/Salesforce.html.md +1 -1
- data/doc_out/Screenshare.html.md +1 -1
- data/doc_out/ScriptsApi.html.md +72 -72
- data/doc_out/Site.html.md +1 -1
- data/doc_out/SocialExpression.html.md +1 -1
- data/doc_out/SortItem.html.md +1 -1
- data/doc_out/TagValue.html.md +1 -1
- data/doc_out/TimeAllowed.html.md +1 -1
- data/doc_out/TimeOffRequest.html.md +2 -2
- data/doc_out/TimeOffRequestPatch.html.md +1 -1
- data/doc_out/TransferRequest.html.md +1 -1
- data/doc_out/Trunk.html.md +1 -1
- data/doc_out/TrunkBase.html.md +1 -1
- data/doc_out/UnreadStatus.html.md +1 -1
- data/doc_out/UserPresence.html.md +1 -1
- data/doc_out/UserPresenceRule.html.md +2 -2
- data/doc_out/UserQueue.html.md +1 -1
- data/doc_out/UserRecording.html.md +1 -1
- data/doc_out/UserRecordingsApi.html.md +47 -47
- data/doc_out/UserScheduleAdherence.html.md +1 -1
- data/doc_out/ValidateAddressResponse.html.md +1 -1
- data/doc_out/Video.html.md +3 -3
- data/doc_out/VoicemailGroupPolicy.html.md +2 -2
- data/doc_out/VoicemailMessage.html.md +2 -2
- data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
- data/doc_out/VoicemailUserPolicy.html.md +1 -1
- data/doc_out/Workspace.html.md +1 -1
- data/doc_out/Wrapup.html.md +1 -1
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud/api/attributes_api.rb +39 -39
- data/lib/purecloud/api/conversations_api.rb +58 -58
- data/lib/purecloud/api/greetings_api.rb +67 -67
- data/lib/purecloud/api/groups_api.rb +104 -104
- data/lib/purecloud/api/identity_provider_api.rb +33 -33
- data/lib/purecloud/api/presence_api.rb +46 -46
- data/lib/purecloud/api/recording_api.rb +76 -76
- data/lib/purecloud/api/scripts_api.rb +87 -87
- data/lib/purecloud/api/user_recordings_api.rb +64 -64
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +0 -2
- data/lib/purecloud/models/aggregation_query.rb +0 -2
- data/lib/purecloud/models/analytics_conversation_segment.rb +0 -6
- data/lib/purecloud/models/analytics_session.rb +0 -4
- data/lib/purecloud/models/audit_message.rb +0 -2
- data/lib/purecloud/models/call.rb +0 -8
- data/lib/purecloud/models/call_forwarding.rb +0 -2
- data/lib/purecloud/models/call_media_participant.rb +0 -12
- data/lib/purecloud/models/callback.rb +0 -4
- data/lib/purecloud/models/callback_media_participant.rb +0 -8
- data/lib/purecloud/models/campaign.rb +0 -2
- data/lib/purecloud/models/campaign_interaction.rb +0 -2
- data/lib/purecloud/models/campaign_rule.rb +0 -4
- data/lib/purecloud/models/campaign_rule_action_entities.rb +0 -2
- data/lib/purecloud/models/campaign_sequence.rb +0 -2
- data/lib/purecloud/models/certificate_details.rb +0 -6
- data/lib/purecloud/models/chat_media_participant.rb +0 -6
- data/lib/purecloud/models/cobrowse_media_participant.rb +0 -6
- data/lib/purecloud/models/condition.rb +0 -2
- data/lib/purecloud/models/contact_sort.rb +0 -2
- data/lib/purecloud/models/content_query_request.rb +0 -2
- data/lib/purecloud/models/content_sort_item.rb +0 -2
- data/lib/purecloud/models/conversation_chat.rb +0 -2
- data/lib/purecloud/models/customer_interaction_center.rb +0 -2
- data/lib/purecloud/models/dialer_contact.rb +0 -2
- data/lib/purecloud/models/document.rb +0 -2
- data/lib/purecloud/models/document_audit.rb +0 -2
- data/lib/purecloud/models/document_update.rb +0 -2
- data/lib/purecloud/models/domain_capabilities.rb +0 -8
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +0 -4
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +0 -4
- data/lib/purecloud/models/domain_logical_interface.rb +0 -6
- data/lib/purecloud/models/domain_network_address.rb +0 -2
- data/lib/purecloud/models/domain_network_command_response.rb +0 -2
- data/lib/purecloud/models/domain_network_route.rb +0 -2
- data/lib/purecloud/models/domain_organization_role.rb +11 -17
- data/lib/purecloud/models/domain_organization_role_create.rb +11 -17
- data/lib/purecloud/models/domain_organization_role_update.rb +11 -17
- data/lib/purecloud/models/domain_permission.rb +0 -2
- data/lib/purecloud/models/domain_permission_policy.rb +0 -2
- data/lib/purecloud/models/domain_physical_capabilities.rb +0 -4
- data/lib/purecloud/models/edge.rb +0 -4
- data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
- data/lib/purecloud/models/edge_group.rb +0 -2
- data/lib/purecloud/models/edge_logs_job_request.rb +0 -2
- data/lib/purecloud/models/email.rb +0 -2
- data/lib/purecloud/models/email_media_participant.rb +0 -6
- data/lib/purecloud/models/endpoint.rb +0 -2
- data/lib/purecloud/models/evaluation.rb +0 -8
- data/lib/purecloud/models/evaluation_form.rb +0 -2
- data/lib/purecloud/models/evaluation_scoring_set.rb +0 -2
- data/lib/purecloud/models/fax_document.rb +0 -2
- data/lib/purecloud/models/field_list.rb +0 -6
- data/lib/purecloud/models/geolocation.rb +0 -2
- data/lib/purecloud/models/geolocation_settings.rb +0 -2
- data/lib/purecloud/models/group.rb +0 -2
- data/lib/purecloud/models/group_update.rb +0 -2
- data/lib/purecloud/models/heart_beat_rule.rb +0 -4
- data/lib/purecloud/models/inbound_domain.rb +0 -2
- data/lib/purecloud/models/initiate_screen_recording.rb +0 -2
- data/lib/purecloud/models/interaction_stats_alert.rb +0 -2
- data/lib/purecloud/models/interaction_stats_rule.rb +0 -4
- data/lib/purecloud/models/json_node.rb +24 -64
- data/lib/purecloud/models/line_status.rb +0 -2
- data/lib/purecloud/models/location_definition.rb +0 -2
- data/lib/purecloud/models/media_participant_request.rb +0 -10
- data/lib/purecloud/models/metered_evaluation_assignment.rb +0 -2
- data/lib/purecloud/models/o_auth_provider.rb +0 -2
- data/lib/purecloud/models/okta.rb +0 -2
- data/lib/purecloud/models/one_login.rb +0 -2
- data/lib/purecloud/models/org_media_utilization.rb +0 -2
- data/lib/purecloud/models/organization.rb +0 -2
- data/lib/purecloud/models/organization_presence.rb +0 -4
- data/lib/purecloud/models/out_of_office.rb +0 -2
- data/lib/purecloud/models/outbound_route.rb +0 -4
- data/lib/purecloud/models/parameter.rb +0 -2
- data/lib/purecloud/models/participant.rb +0 -4
- data/lib/purecloud/models/phone_capabilities.rb +0 -10
- data/lib/purecloud/models/phone_number_status.rb +0 -2
- data/lib/purecloud/models/policy.rb +0 -2
- data/lib/purecloud/models/policy_actions.rb +0 -6
- data/lib/purecloud/models/policy_create.rb +0 -2
- data/lib/purecloud/models/pure_cloud.rb +0 -2
- data/lib/purecloud/models/quality_audit.rb +11 -11
- data/lib/purecloud/models/query_request.rb +0 -2
- data/lib/purecloud/models/question_group.rb +0 -8
- data/lib/purecloud/models/question_group_score.rb +0 -2
- data/lib/purecloud/models/question_score.rb +0 -4
- data/lib/purecloud/models/queue_member.rb +0 -2
- data/lib/purecloud/models/report_schedule.rb +0 -2
- data/lib/purecloud/models/resource_permission_policy.rb +0 -2
- data/lib/purecloud/models/routing_status_rule.rb +0 -4
- data/lib/purecloud/models/salesforce.rb +0 -2
- data/lib/purecloud/models/screenshare.rb +0 -2
- data/lib/purecloud/models/site.rb +0 -2
- data/lib/purecloud/models/social_expression.rb +0 -2
- data/lib/purecloud/models/sort_item.rb +0 -2
- data/lib/purecloud/models/tag_value.rb +0 -2
- data/lib/purecloud/models/time_allowed.rb +0 -2
- data/lib/purecloud/models/time_off_request.rb +0 -4
- data/lib/purecloud/models/time_off_request_patch.rb +0 -2
- data/lib/purecloud/models/transfer_request.rb +0 -2
- data/lib/purecloud/models/trunk.rb +0 -2
- data/lib/purecloud/models/trunk_base.rb +0 -2
- data/lib/purecloud/models/unread_status.rb +0 -2
- data/lib/purecloud/models/user_presence.rb +0 -2
- data/lib/purecloud/models/user_presence_rule.rb +0 -4
- data/lib/purecloud/models/user_queue.rb +0 -2
- data/lib/purecloud/models/user_recording.rb +0 -2
- data/lib/purecloud/models/user_schedule_adherence.rb +0 -2
- data/lib/purecloud/models/validate_address_response.rb +0 -2
- data/lib/purecloud/models/video.rb +0 -6
- data/lib/purecloud/models/voicemail_group_policy.rb +0 -4
- data/lib/purecloud/models/voicemail_message.rb +0 -4
- data/lib/purecloud/models/voicemail_organization_policy.rb +0 -8
- data/lib/purecloud/models/voicemail_user_policy.rb +0 -2
- data/lib/purecloud/models/workspace.rb +0 -2
- data/lib/purecloud/models/wrapup.rb +0 -2
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +2 -2
data/doc_out/Condition.html.md
CHANGED
@@ -8,7 +8,7 @@ title: Condition
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **type** | **String** | The type of the condition | [optional] |
|
11
|
-
| **inverted** | **BOOLEAN** | Indicates whether to evaluate for the opposite of the stated condition; default is false | [optional]
|
11
|
+
| **inverted** | **BOOLEAN** | Indicates whether to evaluate for the opposite of the stated condition; default is false | [optional] |
|
12
12
|
| **attribute_name** | **String** | An attribute name associated with the condition (applies only to certain rule conditions) | [optional] |
|
13
13
|
| **value** | **String** | A value associated with the condition | [optional] |
|
14
14
|
| **value_type** | **String** | Determines the type of the value associated with the condition | [optional] |
|
data/doc_out/ContactSort.html.md
CHANGED
@@ -9,7 +9,7 @@ title: ContactSort
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **field_name** | **String** | | [optional] |
|
11
11
|
| **direction** | **String** | The sort direction | [optional] |
|
12
|
-
| **numeric** | **BOOLEAN** | Whether that column contains numeric data | [optional]
|
12
|
+
| **numeric** | **BOOLEAN** | Whether that column contains numeric data | [optional] |
|
13
13
|
{: class="table table-striped"}
|
14
14
|
|
15
15
|
|
@@ -14,7 +14,7 @@ title: ContentQueryRequest
|
|
14
14
|
| **sort** | [**Array<ContentSortItem>**](ContentSortItem.html) | | [optional] |
|
15
15
|
| **filters** | [**Array<ContentFacetFilterItem>**](ContentFacetFilterItem.html) | | [optional] |
|
16
16
|
| **attribute_filters** | [**Array<ContentAttributeFilterItem>**](ContentAttributeFilterItem.html) | | [optional] |
|
17
|
-
| **include_shares** | **BOOLEAN** | | [optional]
|
17
|
+
| **include_shares** | **BOOLEAN** | | [optional] |
|
18
18
|
{: class="table table-striped"}
|
19
19
|
|
20
20
|
|
@@ -8,7 +8,7 @@ title: ContentSortItem
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **name** | **String** | | [optional] |
|
11
|
-
| **ascending** | **BOOLEAN** | | [optional]
|
11
|
+
| **ascending** | **BOOLEAN** | | [optional] |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
@@ -12,7 +12,7 @@ title: ConversationChat
|
|
12
12
|
| **room_id** | **String** | The room id for the chat. | [optional] |
|
13
13
|
| **recording_id** | **String** | A globally unique identifier for the recording associated with this chat. | [optional] |
|
14
14
|
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's chat, divided into activity segments. | [optional] |
|
15
|
-
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional]
|
15
|
+
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
|
16
16
|
| **direction** | **String** | The direction of the chat | [optional] |
|
17
17
|
| **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
|
18
18
|
| **start_hold_time** | **DateTime** | The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
@@ -11,6 +11,7 @@ Method | HTTP request | Description
|
|
11
11
|
|[**delete_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#delete_calls_call_id_participants_participant_id_consult) | **DELETE** /api/v2/conversations/calls/{callId}/participants/{participantId}/consult | Cancel the transfer|
|
12
12
|
|[**delete_conversation_id_participants_participant_id_codes_addcommunicationcode**](ConversationsApi.html#delete_conversation_id_participants_participant_id_codes_addcommunicationcode) | **DELETE** /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode} | Delete a code used to add a communication to this participant|
|
13
13
|
|[**delete_emails_email_id_messages_draft_attachments_attachment_id**](ConversationsApi.html#delete_emails_email_id_messages_draft_attachments_attachment_id) | **DELETE** /api/v2/conversations/emails/{emailId}/messages/draft/attachments/{attachmentId} | Delete attachment from draft|
|
14
|
+
|[**get**](ConversationsApi.html#get) | **GET** /api/v2/conversations | Get conversations|
|
14
15
|
|[**get_callbacks**](ConversationsApi.html#get_callbacks) | **GET** /api/v2/conversations/callbacks | Get callback conversations|
|
15
16
|
|[**get_callbacks_callback_id**](ConversationsApi.html#get_callbacks_callback_id) | **GET** /api/v2/conversations/callbacks/{callbackId} | Get callback conversation|
|
16
17
|
|[**get_callbacks_callback_id_participants_participant_id_wrapup**](ConversationsApi.html#get_callbacks_callback_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|
@@ -32,7 +33,6 @@ Method | HTTP request | Description
|
|
32
33
|
|[**get_conversation_id**](ConversationsApi.html#get_conversation_id) | **GET** /api/v2/conversations/{conversationId} | Get conversation|
|
33
34
|
|[**get_conversation_id_participants_participant_id_wrapup**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|
34
35
|
|[**get_conversation_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|
35
|
-
|[**get_conversations**](ConversationsApi.html#get_conversations) | **GET** /api/v2/conversations | Get conversations|
|
36
36
|
|[**get_conversations_conversation_id_details**](ConversationsApi.html#get_conversations_conversation_id_details) | **GET** /api/v2/analytics/conversations/{conversationId}/details | Get a conversation by id|
|
37
37
|
|[**get_emails**](ConversationsApi.html#get_emails) | **GET** /api/v2/conversations/emails | Get recent email conversations|
|
38
38
|
|[**get_emails_email_id**](ConversationsApi.html#get_emails_email_id) | **GET** /api/v2/conversations/emails/{emailId} | Get email conversation|
|
@@ -264,6 +264,63 @@ Name | Type | Description | Notes
|
|
264
264
|
|
265
265
|
|
266
266
|
|
267
|
+
<a name="get"></a>
|
268
|
+
|
269
|
+
## -[**ConversationEntityListing**](ConversationEntityListing.html) get(opts)
|
270
|
+
|
271
|
+
Get conversations
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
### Example
|
276
|
+
~~~ruby
|
277
|
+
# load the gem
|
278
|
+
require 'purecloud'
|
279
|
+
# setup authorization
|
280
|
+
@secret = ENV['PURECLOUD_SECRET']
|
281
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
282
|
+
environment = "mypurecloud.com"
|
283
|
+
|
284
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
285
|
+
|
286
|
+
PureCloud.configure do |config|
|
287
|
+
config.access_token = @authToken
|
288
|
+
end
|
289
|
+
|
290
|
+
api_instance = PureCloud::ConversationsApi.new
|
291
|
+
|
292
|
+
opts = {
|
293
|
+
communication_type: "communication_type_example" # String | Call or Chat communication filtering
|
294
|
+
}
|
295
|
+
|
296
|
+
begin
|
297
|
+
#Get conversations
|
298
|
+
result = api_instance.get(opts)
|
299
|
+
p result
|
300
|
+
rescue PureCloud::ApiError => e
|
301
|
+
puts "Exception when calling ConversationsApi->get: #{e}"
|
302
|
+
end
|
303
|
+
~~~
|
304
|
+
|
305
|
+
### Parameters
|
306
|
+
|
307
|
+
Name | Type | Description | Notes
|
308
|
+
------------- | ------------- | ------------- | -------------
|
309
|
+
**communication_type** | **String**| Call or Chat communication filtering | [optional]
|
310
|
+
{: class="table table-striped"}
|
311
|
+
|
312
|
+
|
313
|
+
### Return type
|
314
|
+
|
315
|
+
[**ConversationEntityListing**](ConversationEntityListing.html)
|
316
|
+
|
317
|
+
### HTTP request headers
|
318
|
+
|
319
|
+
- **Content-Type**: application/json
|
320
|
+
- **Accept**: application/json
|
321
|
+
|
322
|
+
|
323
|
+
|
267
324
|
<a name="get_callbacks"></a>
|
268
325
|
|
269
326
|
## -[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_callbacks
|
@@ -1465,63 +1522,6 @@ Name | Type | Description | Notes
|
|
1465
1522
|
|
1466
1523
|
|
1467
1524
|
|
1468
|
-
<a name="get_conversations"></a>
|
1469
|
-
|
1470
|
-
## -[**ConversationEntityListing**](ConversationEntityListing.html) get_conversations(opts)
|
1471
|
-
|
1472
|
-
Get conversations
|
1473
|
-
|
1474
|
-
|
1475
|
-
|
1476
|
-
### Example
|
1477
|
-
~~~ruby
|
1478
|
-
# load the gem
|
1479
|
-
require 'purecloud'
|
1480
|
-
# setup authorization
|
1481
|
-
@secret = ENV['PURECLOUD_SECRET']
|
1482
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
1483
|
-
environment = "mypurecloud.com"
|
1484
|
-
|
1485
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1486
|
-
|
1487
|
-
PureCloud.configure do |config|
|
1488
|
-
config.access_token = @authToken
|
1489
|
-
end
|
1490
|
-
|
1491
|
-
api_instance = PureCloud::ConversationsApi.new
|
1492
|
-
|
1493
|
-
opts = {
|
1494
|
-
communication_type: "communication_type_example" # String | Call or Chat communication filtering
|
1495
|
-
}
|
1496
|
-
|
1497
|
-
begin
|
1498
|
-
#Get conversations
|
1499
|
-
result = api_instance.get_conversations(opts)
|
1500
|
-
p result
|
1501
|
-
rescue PureCloud::ApiError => e
|
1502
|
-
puts "Exception when calling ConversationsApi->get_conversations: #{e}"
|
1503
|
-
end
|
1504
|
-
~~~
|
1505
|
-
|
1506
|
-
### Parameters
|
1507
|
-
|
1508
|
-
Name | Type | Description | Notes
|
1509
|
-
------------- | ------------- | ------------- | -------------
|
1510
|
-
**communication_type** | **String**| Call or Chat communication filtering | [optional]
|
1511
|
-
{: class="table table-striped"}
|
1512
|
-
|
1513
|
-
|
1514
|
-
### Return type
|
1515
|
-
|
1516
|
-
[**ConversationEntityListing**](ConversationEntityListing.html)
|
1517
|
-
|
1518
|
-
### HTTP request headers
|
1519
|
-
|
1520
|
-
- **Content-Type**: application/json
|
1521
|
-
- **Accept**: application/json
|
1522
|
-
|
1523
|
-
|
1524
|
-
|
1525
1525
|
<a name="get_conversations_conversation_id_details"></a>
|
1526
1526
|
|
1527
1527
|
## -[**AnalyticsConversation**](AnalyticsConversation.html) get_conversations_conversation_id_details(conversation_id)
|
@@ -12,7 +12,7 @@ title: CustomerInteractionCenter
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
14
|
| **sso_target_uri** | **String** | | [optional] |
|
15
|
-
| **disabled** | **BOOLEAN** | | [optional]
|
15
|
+
| **disabled** | **BOOLEAN** | | [optional] |
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
@@ -12,7 +12,7 @@ title: DialerContact
|
|
12
12
|
| **contact_list_id** | **String** | Identifier of the contact list containing this contact | |
|
13
13
|
| **data** | **Hash<String, Object>** | An ordered map of the contact's data attributes and values | [optional] |
|
14
14
|
| **call_records** | [**Hash<String, CallRecord>**](CallRecord.html) | A map of call records for the contact phone columns | [optional] |
|
15
|
-
| **callable** | **BOOLEAN** | false if the contact is not to be called | [optional]
|
15
|
+
| **callable** | **BOOLEAN** | false if the contact is not to be called | [optional] |
|
16
16
|
| **phone_number_status** | [**Hash<String, PhoneNumberStatus>**](PhoneNumberStatus.html) | A map of statuses for the contact phone columns | [optional] |
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
18
|
{: class="table table-striped"}
|
data/doc_out/Document.html.md
CHANGED
@@ -22,7 +22,7 @@ title: Document
|
|
22
22
|
| **system_type** | **String** | | [optional] |
|
23
23
|
| **filename** | **String** | | [optional] |
|
24
24
|
| **page_count** | **Integer** | | [optional] |
|
25
|
-
| **read** | **BOOLEAN** | | [optional]
|
25
|
+
| **read** | **BOOLEAN** | | [optional] |
|
26
26
|
| **caller_address** | **String** | | [optional] |
|
27
27
|
| **receiver_address** | **String** | | [optional] |
|
28
28
|
| **tags** | **Array<String>** | | [optional] |
|
@@ -12,7 +12,7 @@ title: DocumentAudit
|
|
12
12
|
| **user** | [**UriReference**](UriReference.html) | | [optional] |
|
13
13
|
| **workspace** | [**UriReference**](UriReference.html) | | [optional] |
|
14
14
|
| **transaction_id** | **String** | | [optional] |
|
15
|
-
| **transaction_initiator** | **BOOLEAN** | | [optional]
|
15
|
+
| **transaction_initiator** | **BOOLEAN** | | [optional] |
|
16
16
|
| **application** | **String** | | [optional] |
|
17
17
|
| **service_name** | **String** | | [optional] |
|
18
18
|
| **level** | **String** | | [optional] |
|
@@ -9,7 +9,7 @@ title: DocumentUpdate
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **change_number** | **Integer** | | [optional] |
|
11
11
|
| **name** | **String** | The name of the document | |
|
12
|
-
| **read** | **BOOLEAN** | | [optional]
|
12
|
+
| **read** | **BOOLEAN** | | [optional] |
|
13
13
|
| **add_tags** | **Array<String>** | | [optional] |
|
14
14
|
| **remove_tags** | **Array<String>** | | [optional] |
|
15
15
|
| **add_tag_ids** | **Array<String>** | | [optional] |
|
@@ -7,11 +7,11 @@ title: DomainCapabilities
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **enabled** | **BOOLEAN** | True if this address family on the interface is enabled. | [optional]
|
11
|
-
| **dhcp** | **BOOLEAN** | True if this address family on the interface is using DHCP. | [optional]
|
10
|
+
| **enabled** | **BOOLEAN** | True if this address family on the interface is enabled. | [optional] |
|
11
|
+
| **dhcp** | **BOOLEAN** | True if this address family on the interface is using DHCP. | [optional] |
|
12
12
|
| **metric** | **Integer** | The metric being used for the address family on this interface. Lower values will have a higher priority. If autoMetric is true, this value will be the automatically calculated metric. To set this value be sure autoMetric is false. If no value is returned, metric configuration is not supported on this Edge. | [optional] |
|
13
|
-
| **auto_metric** | **BOOLEAN** | True if the metric is being calculated automatically for the address family on this interface. | [optional]
|
14
|
-
| **supports_metric** | **BOOLEAN** | True if metric configuration is supported. | [optional]
|
13
|
+
| **auto_metric** | **BOOLEAN** | True if the metric is being calculated automatically for the address family on this interface. | [optional] |
|
14
|
+
| **supports_metric** | **BOOLEAN** | True if metric configuration is supported. | [optional] |
|
15
15
|
{: class="table table-striped"}
|
16
16
|
|
17
17
|
|
@@ -12,10 +12,10 @@ title: DomainEdgeSoftwareUpdateDto
|
|
12
12
|
| **download_start_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
13
|
| **execute_start_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
14
|
| **execute_stop_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
15
|
-
| **execute_on_idle** | **BOOLEAN** | | [optional]
|
15
|
+
| **execute_on_idle** | **BOOLEAN** | | [optional] |
|
16
16
|
| **status** | **String** | | [optional] |
|
17
17
|
| **edge_uri** | **String** | | [optional] |
|
18
|
-
| **current** | **BOOLEAN** | | [optional]
|
18
|
+
| **current** | **BOOLEAN** | | [optional] |
|
19
19
|
{: class="table table-striped"}
|
20
20
|
|
21
21
|
|
@@ -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
|
-
| **latest_release** | **BOOLEAN** | | [optional]
|
16
|
-
| **current** | **BOOLEAN** | | [optional]
|
15
|
+
| **latest_release** | **BOOLEAN** | | [optional] |
|
16
|
+
| **current** | **BOOLEAN** | | [optional] |
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
18
|
{: class="table table-striped"}
|
19
19
|
|
@@ -34,9 +34,9 @@ title: DomainLogicalInterface
|
|
34
34
|
| **last_modified_user_id** | **String** | | [optional] |
|
35
35
|
| **last_modified_correlation_id** | **String** | | [optional] |
|
36
36
|
| **command_responses** | [**Array<DomainNetworkCommandResponse>**](DomainNetworkCommandResponse.html) | | [optional] |
|
37
|
-
| **inherit_phone_trunk_bases_i_pv4** | **BOOLEAN** | The IPv4 phone trunk base assignment will be inherited from the Edge Group. | [optional]
|
38
|
-
| **inherit_phone_trunk_bases_i_pv6** | **BOOLEAN** | The IPv6 phone trunk base assignment will be inherited from the Edge Group. | [optional]
|
39
|
-
| **use_for_internal_edge_communication** | **BOOLEAN** | This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group. | [optional]
|
37
|
+
| **inherit_phone_trunk_bases_i_pv4** | **BOOLEAN** | The IPv4 phone trunk base assignment will be inherited from the Edge Group. | [optional] |
|
38
|
+
| **inherit_phone_trunk_bases_i_pv6** | **BOOLEAN** | The IPv6 phone trunk base assignment will be inherited from the Edge Group. | [optional] |
|
39
|
+
| **use_for_internal_edge_communication** | **BOOLEAN** | This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group. | [optional] |
|
40
40
|
| **external_trunk_base_assignments** | [**Array<TrunkBaseAssignment>**](TrunkBaseAssignment.html) | External trunk base settings to use for external communication from this interface. | [optional] |
|
41
41
|
| **phone_trunk_base_assignments** | [**Array<TrunkBaseAssignment>**](TrunkBaseAssignment.html) | Phone trunk base settings to use for phone communication from this interface. These settings will be ignored when \"inheritPhoneTrunkBases\" is true. | [optional] |
|
42
42
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
@@ -9,7 +9,7 @@ title: DomainNetworkAddress
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **type** | **String** | The type of address. | [optional] |
|
11
11
|
| **address** | **String** | An IPv4 or IPv6 IP address. When specifying an address of type \"ip\", use CIDR format for the subnet mask. | [optional] |
|
12
|
-
| **persistent** | **BOOLEAN** | True if this address will persist on Edge restart. Addresses assigned by DHCP will be returned as false. | [optional]
|
12
|
+
| **persistent** | **BOOLEAN** | True if this address will persist on Edge restart. Addresses assigned by DHCP will be returned as false. | [optional] |
|
13
13
|
| **family** | **Integer** | The address family for this address. | [optional] |
|
14
14
|
{: class="table table-striped"}
|
15
15
|
|
@@ -9,7 +9,7 @@ title: DomainNetworkCommandResponse
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **correlation_id** | **String** | | [optional] |
|
11
11
|
| **command_name** | **String** | | [optional] |
|
12
|
-
| **acknowledged** | **BOOLEAN** | | [optional]
|
12
|
+
| **acknowledged** | **BOOLEAN** | | [optional] |
|
13
13
|
| **error_info** | [**ErrorDetails**](ErrorDetails.html) | | [optional] |
|
14
14
|
{: class="table table-striped"}
|
15
15
|
|
@@ -9,7 +9,7 @@ title: DomainNetworkRoute
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **prefix** | **String** | The IPv4 or IPv6 route prefix in CIDR notation. | [optional] |
|
11
11
|
| **nexthop** | **String** | The IPv4 or IPv6 nexthop IP address. | [optional] |
|
12
|
-
| **persistent** | **BOOLEAN** | True if this route will persist on Edge restart. Routes assigned by DHCP will be returned as false. | [optional]
|
12
|
+
| **persistent** | **BOOLEAN** | True if this route will persist on Edge restart. Routes assigned by DHCP will be returned as false. | [optional] |
|
13
13
|
| **metric** | **Integer** | The metric being used for route. Lower values will have a higher priority. | [optional] |
|
14
14
|
| **family** | **Integer** | The address family for this route. | [optional] |
|
15
15
|
{: class="table table-striped"}
|
@@ -14,9 +14,9 @@ title: DomainOrganizationRole
|
|
14
14
|
| **permissions** | **Array<String>** | | [optional] |
|
15
15
|
| **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
|
-
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional]
|
18
|
-
| **
|
19
|
-
| **
|
17
|
+
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
+
| **default** | **BOOLEAN** | | [optional] |
|
19
|
+
| **base** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -14,9 +14,9 @@ title: DomainOrganizationRoleCreate
|
|
14
14
|
| **permissions** | **Array<String>** | | [optional] |
|
15
15
|
| **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
|
-
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional]
|
18
|
-
| **
|
19
|
-
| **
|
17
|
+
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
+
| **default** | **BOOLEAN** | | [optional] |
|
19
|
+
| **base** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -14,9 +14,9 @@ title: DomainOrganizationRoleUpdate
|
|
14
14
|
| **permissions** | **Array<String>** | | [optional] |
|
15
15
|
| **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
|
-
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional]
|
18
|
-
| **
|
19
|
-
| **
|
17
|
+
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
+
| **default** | **BOOLEAN** | | [optional] |
|
19
|
+
| **base** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -11,7 +11,7 @@ title: DomainPermission
|
|
11
11
|
| **entity_type** | **String** | | [optional] |
|
12
12
|
| **action** | **String** | | [optional] |
|
13
13
|
| **label** | **String** | | [optional] |
|
14
|
-
| **allows_conditions** | **BOOLEAN** | | [optional]
|
14
|
+
| **allows_conditions** | **BOOLEAN** | | [optional] |
|
15
15
|
{: class="table table-striped"}
|
16
16
|
|
17
17
|
|
@@ -13,7 +13,7 @@ title: DomainPermissionPolicy
|
|
13
13
|
| **policy_description** | **String** | | [optional] |
|
14
14
|
| **action_set** | **Array<String>** | | [optional] |
|
15
15
|
| **named_resources** | **Array<String>** | | [optional] |
|
16
|
-
| **allow_conditions** | **BOOLEAN** | | [optional]
|
16
|
+
| **allow_conditions** | **BOOLEAN** | | [optional] |
|
17
17
|
| **resource_condition_node** | [**DomainResourceConditionNode**](DomainResourceConditionNode.html) | | [optional] |
|
18
18
|
{: class="table table-striped"}
|
19
19
|
|
@@ -7,8 +7,8 @@ title: DomainPhysicalCapabilities
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **vlan** | **BOOLEAN** | | [optional]
|
11
|
-
| **team** | **BOOLEAN** | | [optional]
|
10
|
+
| **vlan** | **BOOLEAN** | | [optional] |
|
11
|
+
| **team** | **BOOLEAN** | | [optional] |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
data/doc_out/Edge.html.md
CHANGED
@@ -39,8 +39,8 @@ title: Edge
|
|
39
39
|
| **software_status** | [**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) | | [optional] |
|
40
40
|
| **online_status** | **String** | | [optional] |
|
41
41
|
| **serial_number** | **String** | | [optional] |
|
42
|
-
| **physical_edge** | **BOOLEAN** | | [optional]
|
43
|
-
| **managed** | **BOOLEAN** | | [optional]
|
42
|
+
| **physical_edge** | **BOOLEAN** | | [optional] |
|
43
|
+
| **managed** | **BOOLEAN** | | [optional] |
|
44
44
|
| **edge_deployment_type** | **String** | | [optional] |
|
45
45
|
| **call_draining_state** | **String** | | [optional] |
|
46
46
|
| **conversation_count** | **Integer** | | [optional] |
|
@@ -9,8 +9,8 @@ title: EdgeAutoUpdateConfig
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **time_zone** | **String** | | [optional] |
|
11
11
|
| **rrule** | **String** | | [optional] |
|
12
|
-
| **start** | **
|
13
|
-
| **_end** | **
|
12
|
+
| **start** | **String** | Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS | [optional] |
|
13
|
+
| **_end** | **String** | Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS | [optional] |
|
14
14
|
{: class="table table-striped"}
|
15
15
|
|
16
16
|
|
data/doc_out/EdgeGroup.html.md
CHANGED
@@ -18,7 +18,7 @@ title: EdgeGroup
|
|
18
18
|
| **state** | **String** | | [optional] |
|
19
19
|
| **modified_by_app** | **String** | | [optional] |
|
20
20
|
| **created_by_app** | **String** | | [optional] |
|
21
|
-
| **managed** | **BOOLEAN** | Is this edge group being managed remotely. | [optional]
|
21
|
+
| **managed** | **BOOLEAN** | Is this edge group being managed remotely. | [optional] |
|
22
22
|
| **edge_trunk_base_assignment** | [**TrunkBaseAssignment**](TrunkBaseAssignment.html) | A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication. | |
|
23
23
|
| **phone_trunk_bases** | [**Array<TrunkBase>**](TrunkBase.html) | Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication. | [optional] |
|
24
24
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
@@ -9,7 +9,7 @@ title: EdgeLogsJobRequest
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **path** | **String** | A relative directory to the root Edge log folder to query from. | [optional] |
|
11
11
|
| **query** | **String** | The pattern to use when searching for logs, which may include the wildcards {*, ?}. Multiple search patterns may be combined using a pipe '|' as a delimiter. | [optional] |
|
12
|
-
| **recurse** | **BOOLEAN** | Boolean whether or not to recurse into directories. | [optional]
|
12
|
+
| **recurse** | **BOOLEAN** | Boolean whether or not to recurse into directories. | [optional] |
|
13
13
|
{: class="table table-striped"}
|
14
14
|
|
15
15
|
|