purecloud 0.47.1 → 0.48.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/AgentActivityEntityListing.html.md +1 -1
- data/doc_out/AttributeEntityListing.html.md +1 -1
- data/doc_out/AvailableTopicEntityListing.html.md +1 -1
- data/doc_out/CalibrationEntityListing.html.md +1 -1
- data/doc_out/CallConversationEntityListing.html.md +1 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +1 -1
- data/doc_out/CallbackConversationEntityListing.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +1 -1
- data/doc_out/CampaignSequenceEntityListing.html.md +1 -1
- data/doc_out/CertificateAuthorityEntityListing.html.md +1 -1
- data/doc_out/ChannelEntityListing.html.md +1 -1
- data/doc_out/ChannelTopicEntityListing.html.md +1 -1
- data/doc_out/ChatConversationEntityListing.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +1 -1
- data/doc_out/ContactListEntityListing.html.md +1 -1
- data/doc_out/Conversation.html.md +1 -0
- data/doc_out/ConversationEntityListing.html.md +1 -1
- data/doc_out/ConversationsApi.html.md +378 -3
- data/doc_out/DIDEntityListing.html.md +1 -1
- data/doc_out/DIDPoolEntityListing.html.md +1 -1
- data/doc_out/DialerContactEntityListing.html.md +1 -1
- data/doc_out/DncListEntityListing.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +1 -1
- data/doc_out/DocumentEntityListing.html.md +1 -1
- data/doc_out/DomainEntityListing.html.md +1 -1
- data/doc_out/DomainEntityListingEvaluationForm.html.md +1 -1
- data/doc_out/DomainEntityListingQueryResult.html.md +1 -1
- data/doc_out/EdgeEntityListing.html.md +1 -1
- data/doc_out/EdgeGroupEntityListing.html.md +1 -1
- data/doc_out/EdgeLineEntityListing.html.md +1 -1
- data/doc_out/EmailConversationEntityListing.html.md +1 -1
- data/doc_out/EmailMessageListing.html.md +1 -1
- data/doc_out/EncryptionKeyEntityListing.html.md +1 -1
- data/doc_out/EndpointEntityListing.html.md +1 -1
- data/doc_out/EvaluationEntityListing.html.md +1 -1
- data/doc_out/EvaluationFormEntityListing.html.md +1 -1
- data/doc_out/EvaluatorActivityEntityListing.html.md +1 -1
- data/doc_out/ExtensionEntityListing.html.md +1 -1
- data/doc_out/ExtensionPoolEntityListing.html.md +1 -1
- data/doc_out/FaxDocumentEntityListing.html.md +1 -1
- data/doc_out/GroupEntityListing.html.md +1 -1
- data/doc_out/InboundDomainEntityListing.html.md +1 -1
- data/doc_out/InboundRouteEntityListing.html.md +1 -1
- data/doc_out/InteractionStatsAlertContainer.html.md +1 -1
- data/doc_out/InteractionStatsRuleContainer.html.md +1 -1
- data/doc_out/JsonNode.html.md +1 -1
- data/doc_out/KeywordSetEntityListing.html.md +1 -1
- data/doc_out/LanguageEntityListing.html.md +1 -1
- data/doc_out/LibraryEntityListing.html.md +1 -1
- data/doc_out/LineBaseEntityListing.html.md +1 -1
- data/doc_out/LineEntityListing.html.md +1 -1
- data/doc_out/LogicalInterfaceEntityListing.html.md +1 -1
- data/doc_out/OAuthClientEntityListing.html.md +1 -1
- data/doc_out/OAuthProviderEntityListing.html.md +1 -1
- data/doc_out/OrganizationPresenceEntityListing.html.md +1 -1
- data/doc_out/OrganizationRoleEntityListing.html.md +1 -1
- data/doc_out/OrphanRecordingListing.html.md +1 -1
- data/doc_out/OutboundRouteEntityListing.html.md +1 -1
- data/doc_out/PermissionCollectionEntityListing.html.md +1 -1
- data/doc_out/PhoneBaseEntityListing.html.md +1 -1
- data/doc_out/PhoneEntityListing.html.md +1 -1
- data/doc_out/PhoneMetaBaseEntityListing.html.md +1 -1
- data/doc_out/PhysicalInterfaceEntityListing.html.md +1 -1
- data/doc_out/PolicyEntityListing.html.md +1 -1
- data/doc_out/QualityAuditPage.html.md +1 -1
- data/doc_out/QueueEntityListing.html.md +1 -1
- data/doc_out/ReportMetaDataEntityListing.html.md +1 -1
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +1 -1
- data/doc_out/ReportScheduleEntityListing.html.md +1 -1
- data/doc_out/ResponseEntityList.html.md +1 -1
- data/doc_out/ResponseEntityListing.html.md +1 -1
- data/doc_out/ResponseSetEntityListing.html.md +1 -1
- data/doc_out/RuleSetEntityListing.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +1 -1
- data/doc_out/SchemaReferenceEntityListing.html.md +1 -1
- data/doc_out/SecurityProfileEntityListing.html.md +1 -1
- data/doc_out/ShareEntityListing.html.md +1 -1
- data/doc_out/SiteEntityListing.html.md +1 -1
- data/doc_out/SkillEntityListing.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +1 -1
- data/doc_out/TagValueEntityListing.html.md +1 -1
- data/doc_out/TimeZoneEntityListing.html.md +1 -1
- data/doc_out/TrunkEntityListing.html.md +1 -1
- data/doc_out/TrunkMetabaseEntityListing.html.md +1 -1
- data/doc_out/User.html.md +1 -1
- data/doc_out/UserEntityListing.html.md +1 -1
- data/doc_out/UserMe.html.md +1 -1
- data/doc_out/UserQueueEntityListing.html.md +1 -1
- data/doc_out/UserRecordingEntityListing.html.md +1 -1
- data/doc_out/UserSkillEntityListing.html.md +1 -1
- data/doc_out/UsersEntityListing.html.md +1 -1
- data/doc_out/WorkspaceEntityListing.html.md +1 -1
- data/doc_out/WorkspaceMemberEntityListing.html.md +1 -1
- data/doc_out/WrapupCodeEntityListing.html.md +1 -1
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud/api/conversations_api.rb +419 -2
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
- data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
- data/lib/purecloud/models/available_topic_entity_listing.rb +11 -11
- data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
- data/lib/purecloud/models/call_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
- data/lib/purecloud/models/channel_entity_listing.rb +11 -11
- data/lib/purecloud/models/channel_topic_entity_listing.rb +11 -11
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
- data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
- data/lib/purecloud/models/conversation.rb +21 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/dialer_contact_entity_listing.rb +11 -11
- data/lib/purecloud/models/did_entity_listing.rb +11 -11
- data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
- data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
- data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
- data/lib/purecloud/models/document_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
- data/lib/purecloud/models/edge_entity_listing.rb +11 -11
- data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
- data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
- data/lib/purecloud/models/email_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/email_message_listing.rb +11 -11
- data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
- data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
- data/lib/purecloud/models/extension_entity_listing.rb +11 -11
- data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
- data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
- data/lib/purecloud/models/group_entity_listing.rb +11 -11
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
- data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
- data/lib/purecloud/models/interaction_stats_alert_container.rb +11 -11
- data/lib/purecloud/models/interaction_stats_rule_container.rb +11 -11
- data/lib/purecloud/models/json_node.rb +13 -13
- data/lib/purecloud/models/keyword_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/language_entity_listing.rb +11 -11
- data/lib/purecloud/models/library_entity_listing.rb +11 -11
- data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/line_entity_listing.rb +11 -11
- data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
- data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
- data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
- data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
- data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
- data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
- data/lib/purecloud/models/policy_entity_listing.rb +11 -11
- data/lib/purecloud/models/quality_audit_page.rb +11 -11
- data/lib/purecloud/models/queue_entity_listing.rb +11 -11
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
- data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
- data/lib/purecloud/models/response_entity_list.rb +11 -11
- data/lib/purecloud/models/response_entity_listing.rb +11 -11
- data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
- data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
- data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
- data/lib/purecloud/models/share_entity_listing.rb +11 -11
- data/lib/purecloud/models/site_entity_listing.rb +11 -11
- data/lib/purecloud/models/skill_entity_listing.rb +11 -11
- data/lib/purecloud/models/station_entity_listing.rb +11 -11
- data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
- data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
- data/lib/purecloud/models/trunk_entity_listing.rb +11 -11
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
- data/lib/purecloud/models/user.rb +1 -1
- data/lib/purecloud/models/user_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_me.rb +1 -1
- data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
- data/lib/purecloud/models/users_entity_listing.rb +11 -11
- data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
- data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 56e15f539db01c327d858a7d2958a014635a6e0f
|
4
|
+
data.tar.gz: 8b0e9b589e867fece993be090cbc198aef2e1894
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1e64189263f7f1fcf0f3aae5756171b137dc07c8189f2b0f073f2a6e2675925ac5e22d184c4ba9a2e34357f139158287e3651a545fbffdf6f250d8c0ea09da3f
|
7
|
+
data.tar.gz: f6abfa54bc391b6476a25de47fc37fc54f521555a8564e25c2b9a5e1c5914ffbb239f0ec65560a26addc04b12879a142611d2eeaee99d9d0854f08eeb136e2f6
|
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-07-
|
12
|
+
- Package version: 0.48.1
|
13
|
+
- Build date: 2016-07-24T03:13:54.417Z
|
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.48.1'
|
22
22
|
|
23
23
|
### Install from Git
|
24
24
|
|
data/config-ruby.json
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"gemVersion":"0.
|
1
|
+
{"gemVersion":"0.48.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.48.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
|
@@ -14,8 +14,8 @@ title: AgentActivityEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: AttributeEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: AvailableTopicEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CalibrationEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CallConversationEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CallableTimeSetEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CallbackConversationEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CampaignEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CampaignSequenceEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CertificateAuthorityEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: ChannelEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: ChannelTopicEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: ChatConversationEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: CommandStatusEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: ContactListEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -16,6 +16,7 @@ title: Conversation
|
|
16
16
|
| **conversation_ids** | **Array<String>** | A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference. | [optional] |
|
17
17
|
| **max_participants** | **Integer** | If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. | [optional] |
|
18
18
|
| **recording_state** | **String** | On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording. | [optional] |
|
19
|
+
| **state** | **String** | The conversation's state. Values can be: 'disconnected' | [optional] |
|
19
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
20
21
|
{: class="table table-striped"}
|
21
22
|
|
@@ -14,8 +14,8 @@ title: ConversationEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -37,16 +37,22 @@ Method | HTTP request | Description
|
|
37
37
|
|[**get_emails_email_id_messages_message_id**](ConversationsApi.html#get_emails_email_id_messages_message_id) | **GET** /api/v2/conversations/emails/{emailId}/messages/{messageId} | Get conversation message|
|
38
38
|
|[**get_emails_email_id_participants_participant_id_wrapup**](ConversationsApi.html#get_emails_email_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|
39
39
|
|[**get_emails_email_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_emails_email_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|
40
|
+
|[**patch_callbacks_callback_id**](ConversationsApi.html#patch_callbacks_callback_id) | **PATCH** /api/v2/conversations/callbacks/{callbackId} | Update a conversation by disconnecting all of the participants|
|
40
41
|
|[**patch_callbacks_callback_id_participants_participant_id**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId} | Update conversation participant|
|
41
42
|
|[**patch_callbacks_callback_id_participants_participant_id_attributes**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
42
|
-
|[**
|
43
|
+
|[**patch_callbacks_callback_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
44
|
+
|[**patch_calls_call_id**](ConversationsApi.html#patch_calls_call_id) | **PATCH** /api/v2/conversations/calls/{callId} | Update a conversation by setting it's recording state or disconnecting all of the participants|
|
43
45
|
|[**patch_calls_call_id_participants_participant_id**](ConversationsApi.html#patch_calls_call_id_participants_participant_id) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId} | Update conversation participant|
|
44
46
|
|[**patch_calls_call_id_participants_participant_id_attributes**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
47
|
+
|[**patch_calls_call_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
45
48
|
|[**patch_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_consult) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId}/consult | Change who can speak|
|
49
|
+
|[**patch_chats_chat_id**](ConversationsApi.html#patch_chats_chat_id) | **PATCH** /api/v2/conversations/chats/{chatId} | Update a conversation by disconnecting all of the participants|
|
46
50
|
|[**patch_chats_chat_id_participants_participant_id**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId} | Update conversation participant|
|
47
51
|
|[**patch_chats_chat_id_participants_participant_id_attributes**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
52
|
+
|[**patch_chats_chat_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
48
53
|
|[**patch_conversation_id_participants_participant_id**](ConversationsApi.html#patch_conversation_id_participants_participant_id) | **PATCH** /api/v2/conversations/{conversationId}/participants/{participantId} | Update a participant.|
|
49
54
|
|[**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.|
|
55
|
+
|[**patch_emails_email_id**](ConversationsApi.html#patch_emails_email_id) | **PATCH** /api/v2/conversations/emails/{emailId} | Update a conversation by disconnecting all of the participants|
|
50
56
|
|[**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|
|
51
57
|
|[**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.|
|
52
58
|
|[**post_callbacks**](ConversationsApi.html#post_callbacks) | **POST** /api/v2/conversations/callbacks | Create a Callback|
|
@@ -1733,6 +1739,65 @@ Name | Type | Description | Notes
|
|
1733
1739
|
|
1734
1740
|
|
1735
1741
|
|
1742
|
+
<a name="patch_callbacks_callback_id"></a>
|
1743
|
+
|
1744
|
+
## -[**Conversation**](Conversation.html) patch_callbacks_callback_id(callback_id, body)
|
1745
|
+
|
1746
|
+
Update a conversation by disconnecting all of the participants
|
1747
|
+
|
1748
|
+
|
1749
|
+
|
1750
|
+
### Example
|
1751
|
+
~~~ruby
|
1752
|
+
# load the gem
|
1753
|
+
require 'purecloud'
|
1754
|
+
# setup authorization
|
1755
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1756
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1757
|
+
environment = "mypurecloud.com"
|
1758
|
+
|
1759
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1760
|
+
|
1761
|
+
PureCloud.configure do |config|
|
1762
|
+
config.access_token = @authToken
|
1763
|
+
end
|
1764
|
+
|
1765
|
+
api_instance = PureCloud::ConversationsApi.new
|
1766
|
+
|
1767
|
+
callback_id = "callback_id_example" # String |
|
1768
|
+
|
1769
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
1770
|
+
|
1771
|
+
|
1772
|
+
begin
|
1773
|
+
#Update a conversation by disconnecting all of the participants
|
1774
|
+
result = api_instance.patch_callbacks_callback_id(callback_id, body)
|
1775
|
+
p result
|
1776
|
+
rescue PureCloud::ApiError => e
|
1777
|
+
puts "Exception when calling ConversationsApi->patch_callbacks_callback_id: #{e}"
|
1778
|
+
end
|
1779
|
+
~~~
|
1780
|
+
|
1781
|
+
### Parameters
|
1782
|
+
|
1783
|
+
Name | Type | Description | Notes
|
1784
|
+
------------- | ------------- | ------------- | -------------
|
1785
|
+
**callback_id** | **String**| |
|
1786
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
1787
|
+
{: class="table table-striped"}
|
1788
|
+
|
1789
|
+
|
1790
|
+
### Return type
|
1791
|
+
|
1792
|
+
[**Conversation**](Conversation.html)
|
1793
|
+
|
1794
|
+
### HTTP request headers
|
1795
|
+
|
1796
|
+
- **Content-Type**: application/json
|
1797
|
+
- **Accept**: application/json
|
1798
|
+
|
1799
|
+
|
1800
|
+
|
1736
1801
|
<a name="patch_callbacks_callback_id_participants_participant_id"></a>
|
1737
1802
|
|
1738
1803
|
## - patch_callbacks_callback_id_participants_participant_id(callback_id, participant_id, body)
|
@@ -1855,11 +1920,75 @@ nil (empty response body)
|
|
1855
1920
|
|
1856
1921
|
|
1857
1922
|
|
1923
|
+
<a name="patch_callbacks_callback_id_participants_participant_id_communications_communication_id"></a>
|
1924
|
+
|
1925
|
+
## - patch_callbacks_callback_id_participants_participant_id_communications_communication_id(callback_id, participant_id, communication_id, body)
|
1926
|
+
|
1927
|
+
Update conversation participant's communication by disconnecting it.
|
1928
|
+
|
1929
|
+
|
1930
|
+
|
1931
|
+
### Example
|
1932
|
+
~~~ruby
|
1933
|
+
# load the gem
|
1934
|
+
require 'purecloud'
|
1935
|
+
# setup authorization
|
1936
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1937
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1938
|
+
environment = "mypurecloud.com"
|
1939
|
+
|
1940
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1941
|
+
|
1942
|
+
PureCloud.configure do |config|
|
1943
|
+
config.access_token = @authToken
|
1944
|
+
end
|
1945
|
+
|
1946
|
+
api_instance = PureCloud::ConversationsApi.new
|
1947
|
+
|
1948
|
+
callback_id = "callback_id_example" # String |
|
1949
|
+
|
1950
|
+
participant_id = "participant_id_example" # String |
|
1951
|
+
|
1952
|
+
communication_id = "communication_id_example" # String |
|
1953
|
+
|
1954
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
1955
|
+
|
1956
|
+
|
1957
|
+
begin
|
1958
|
+
#Update conversation participant's communication by disconnecting it.
|
1959
|
+
api_instance.patch_callbacks_callback_id_participants_participant_id_communications_communication_id(callback_id, participant_id, communication_id, body)
|
1960
|
+
rescue PureCloud::ApiError => e
|
1961
|
+
puts "Exception when calling ConversationsApi->patch_callbacks_callback_id_participants_participant_id_communications_communication_id: #{e}"
|
1962
|
+
end
|
1963
|
+
~~~
|
1964
|
+
|
1965
|
+
### Parameters
|
1966
|
+
|
1967
|
+
Name | Type | Description | Notes
|
1968
|
+
------------- | ------------- | ------------- | -------------
|
1969
|
+
**callback_id** | **String**| |
|
1970
|
+
**participant_id** | **String**| |
|
1971
|
+
**communication_id** | **String**| |
|
1972
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
1973
|
+
{: class="table table-striped"}
|
1974
|
+
|
1975
|
+
|
1976
|
+
### Return type
|
1977
|
+
|
1978
|
+
nil (empty response body)
|
1979
|
+
|
1980
|
+
### HTTP request headers
|
1981
|
+
|
1982
|
+
- **Content-Type**: application/json
|
1983
|
+
- **Accept**: application/json
|
1984
|
+
|
1985
|
+
|
1986
|
+
|
1858
1987
|
<a name="patch_calls_call_id"></a>
|
1859
1988
|
|
1860
1989
|
## -[**Conversation**](Conversation.html) patch_calls_call_id(call_id, body)
|
1861
1990
|
|
1862
|
-
Update conversation
|
1991
|
+
Update a conversation by setting it's recording state or disconnecting all of the participants
|
1863
1992
|
|
1864
1993
|
|
1865
1994
|
|
@@ -1886,7 +2015,7 @@ body = PureCloud::Conversation.new # Conversation | Conversation
|
|
1886
2015
|
|
1887
2016
|
|
1888
2017
|
begin
|
1889
|
-
#Update conversation
|
2018
|
+
#Update a conversation by setting it's recording state or disconnecting all of the participants
|
1890
2019
|
result = api_instance.patch_calls_call_id(call_id, body)
|
1891
2020
|
p result
|
1892
2021
|
rescue PureCloud::ApiError => e
|
@@ -2036,6 +2165,70 @@ nil (empty response body)
|
|
2036
2165
|
|
2037
2166
|
|
2038
2167
|
|
2168
|
+
<a name="patch_calls_call_id_participants_participant_id_communications_communication_id"></a>
|
2169
|
+
|
2170
|
+
## - patch_calls_call_id_participants_participant_id_communications_communication_id(call_id, participant_id, communication_id, body)
|
2171
|
+
|
2172
|
+
Update conversation participant's communication by disconnecting it.
|
2173
|
+
|
2174
|
+
|
2175
|
+
|
2176
|
+
### Example
|
2177
|
+
~~~ruby
|
2178
|
+
# load the gem
|
2179
|
+
require 'purecloud'
|
2180
|
+
# setup authorization
|
2181
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2182
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2183
|
+
environment = "mypurecloud.com"
|
2184
|
+
|
2185
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2186
|
+
|
2187
|
+
PureCloud.configure do |config|
|
2188
|
+
config.access_token = @authToken
|
2189
|
+
end
|
2190
|
+
|
2191
|
+
api_instance = PureCloud::ConversationsApi.new
|
2192
|
+
|
2193
|
+
call_id = "call_id_example" # String |
|
2194
|
+
|
2195
|
+
participant_id = "participant_id_example" # String |
|
2196
|
+
|
2197
|
+
communication_id = "communication_id_example" # String |
|
2198
|
+
|
2199
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
2200
|
+
|
2201
|
+
|
2202
|
+
begin
|
2203
|
+
#Update conversation participant's communication by disconnecting it.
|
2204
|
+
api_instance.patch_calls_call_id_participants_participant_id_communications_communication_id(call_id, participant_id, communication_id, body)
|
2205
|
+
rescue PureCloud::ApiError => e
|
2206
|
+
puts "Exception when calling ConversationsApi->patch_calls_call_id_participants_participant_id_communications_communication_id: #{e}"
|
2207
|
+
end
|
2208
|
+
~~~
|
2209
|
+
|
2210
|
+
### Parameters
|
2211
|
+
|
2212
|
+
Name | Type | Description | Notes
|
2213
|
+
------------- | ------------- | ------------- | -------------
|
2214
|
+
**call_id** | **String**| |
|
2215
|
+
**participant_id** | **String**| |
|
2216
|
+
**communication_id** | **String**| |
|
2217
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
2218
|
+
{: class="table table-striped"}
|
2219
|
+
|
2220
|
+
|
2221
|
+
### Return type
|
2222
|
+
|
2223
|
+
nil (empty response body)
|
2224
|
+
|
2225
|
+
### HTTP request headers
|
2226
|
+
|
2227
|
+
- **Content-Type**: application/json
|
2228
|
+
- **Accept**: application/json
|
2229
|
+
|
2230
|
+
|
2231
|
+
|
2039
2232
|
<a name="patch_calls_call_id_participants_participant_id_consult"></a>
|
2040
2233
|
|
2041
2234
|
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) patch_calls_call_id_participants_participant_id_consult(call_id, participant_id, body)
|
@@ -2098,6 +2291,65 @@ Name | Type | Description | Notes
|
|
2098
2291
|
|
2099
2292
|
|
2100
2293
|
|
2294
|
+
<a name="patch_chats_chat_id"></a>
|
2295
|
+
|
2296
|
+
## -[**Conversation**](Conversation.html) patch_chats_chat_id(chat_id, body)
|
2297
|
+
|
2298
|
+
Update a conversation by disconnecting all of the participants
|
2299
|
+
|
2300
|
+
|
2301
|
+
|
2302
|
+
### Example
|
2303
|
+
~~~ruby
|
2304
|
+
# load the gem
|
2305
|
+
require 'purecloud'
|
2306
|
+
# setup authorization
|
2307
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2308
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2309
|
+
environment = "mypurecloud.com"
|
2310
|
+
|
2311
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2312
|
+
|
2313
|
+
PureCloud.configure do |config|
|
2314
|
+
config.access_token = @authToken
|
2315
|
+
end
|
2316
|
+
|
2317
|
+
api_instance = PureCloud::ConversationsApi.new
|
2318
|
+
|
2319
|
+
chat_id = "chat_id_example" # String |
|
2320
|
+
|
2321
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
2322
|
+
|
2323
|
+
|
2324
|
+
begin
|
2325
|
+
#Update a conversation by disconnecting all of the participants
|
2326
|
+
result = api_instance.patch_chats_chat_id(chat_id, body)
|
2327
|
+
p result
|
2328
|
+
rescue PureCloud::ApiError => e
|
2329
|
+
puts "Exception when calling ConversationsApi->patch_chats_chat_id: #{e}"
|
2330
|
+
end
|
2331
|
+
~~~
|
2332
|
+
|
2333
|
+
### Parameters
|
2334
|
+
|
2335
|
+
Name | Type | Description | Notes
|
2336
|
+
------------- | ------------- | ------------- | -------------
|
2337
|
+
**chat_id** | **String**| |
|
2338
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
2339
|
+
{: class="table table-striped"}
|
2340
|
+
|
2341
|
+
|
2342
|
+
### Return type
|
2343
|
+
|
2344
|
+
[**Conversation**](Conversation.html)
|
2345
|
+
|
2346
|
+
### HTTP request headers
|
2347
|
+
|
2348
|
+
- **Content-Type**: application/json
|
2349
|
+
- **Accept**: application/json
|
2350
|
+
|
2351
|
+
|
2352
|
+
|
2101
2353
|
<a name="patch_chats_chat_id_participants_participant_id"></a>
|
2102
2354
|
|
2103
2355
|
## - patch_chats_chat_id_participants_participant_id(chat_id, participant_id, body)
|
@@ -2220,6 +2472,70 @@ nil (empty response body)
|
|
2220
2472
|
|
2221
2473
|
|
2222
2474
|
|
2475
|
+
<a name="patch_chats_chat_id_participants_participant_id_communications_communication_id"></a>
|
2476
|
+
|
2477
|
+
## - patch_chats_chat_id_participants_participant_id_communications_communication_id(chat_id, participant_id, communication_id, body)
|
2478
|
+
|
2479
|
+
Update conversation participant's communication by disconnecting it.
|
2480
|
+
|
2481
|
+
|
2482
|
+
|
2483
|
+
### Example
|
2484
|
+
~~~ruby
|
2485
|
+
# load the gem
|
2486
|
+
require 'purecloud'
|
2487
|
+
# setup authorization
|
2488
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2489
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2490
|
+
environment = "mypurecloud.com"
|
2491
|
+
|
2492
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2493
|
+
|
2494
|
+
PureCloud.configure do |config|
|
2495
|
+
config.access_token = @authToken
|
2496
|
+
end
|
2497
|
+
|
2498
|
+
api_instance = PureCloud::ConversationsApi.new
|
2499
|
+
|
2500
|
+
chat_id = "chat_id_example" # String |
|
2501
|
+
|
2502
|
+
participant_id = "participant_id_example" # String |
|
2503
|
+
|
2504
|
+
communication_id = "communication_id_example" # String |
|
2505
|
+
|
2506
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
2507
|
+
|
2508
|
+
|
2509
|
+
begin
|
2510
|
+
#Update conversation participant's communication by disconnecting it.
|
2511
|
+
api_instance.patch_chats_chat_id_participants_participant_id_communications_communication_id(chat_id, participant_id, communication_id, body)
|
2512
|
+
rescue PureCloud::ApiError => e
|
2513
|
+
puts "Exception when calling ConversationsApi->patch_chats_chat_id_participants_participant_id_communications_communication_id: #{e}"
|
2514
|
+
end
|
2515
|
+
~~~
|
2516
|
+
|
2517
|
+
### Parameters
|
2518
|
+
|
2519
|
+
Name | Type | Description | Notes
|
2520
|
+
------------- | ------------- | ------------- | -------------
|
2521
|
+
**chat_id** | **String**| |
|
2522
|
+
**participant_id** | **String**| |
|
2523
|
+
**communication_id** | **String**| |
|
2524
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
2525
|
+
{: class="table table-striped"}
|
2526
|
+
|
2527
|
+
|
2528
|
+
### Return type
|
2529
|
+
|
2530
|
+
nil (empty response body)
|
2531
|
+
|
2532
|
+
### HTTP request headers
|
2533
|
+
|
2534
|
+
- **Content-Type**: application/json
|
2535
|
+
- **Accept**: application/json
|
2536
|
+
|
2537
|
+
|
2538
|
+
|
2223
2539
|
<a name="patch_conversation_id_participants_participant_id"></a>
|
2224
2540
|
|
2225
2541
|
## - patch_conversation_id_participants_participant_id(conversation_id, participant_id, body)
|
@@ -2342,6 +2658,65 @@ nil (empty response body)
|
|
2342
2658
|
|
2343
2659
|
|
2344
2660
|
|
2661
|
+
<a name="patch_emails_email_id"></a>
|
2662
|
+
|
2663
|
+
## -[**Conversation**](Conversation.html) patch_emails_email_id(email_id, body)
|
2664
|
+
|
2665
|
+
Update a conversation by disconnecting all of the participants
|
2666
|
+
|
2667
|
+
|
2668
|
+
|
2669
|
+
### Example
|
2670
|
+
~~~ruby
|
2671
|
+
# load the gem
|
2672
|
+
require 'purecloud'
|
2673
|
+
# setup authorization
|
2674
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2675
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2676
|
+
environment = "mypurecloud.com"
|
2677
|
+
|
2678
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2679
|
+
|
2680
|
+
PureCloud.configure do |config|
|
2681
|
+
config.access_token = @authToken
|
2682
|
+
end
|
2683
|
+
|
2684
|
+
api_instance = PureCloud::ConversationsApi.new
|
2685
|
+
|
2686
|
+
email_id = "email_id_example" # String |
|
2687
|
+
|
2688
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
2689
|
+
|
2690
|
+
|
2691
|
+
begin
|
2692
|
+
#Update a conversation by disconnecting all of the participants
|
2693
|
+
result = api_instance.patch_emails_email_id(email_id, body)
|
2694
|
+
p result
|
2695
|
+
rescue PureCloud::ApiError => e
|
2696
|
+
puts "Exception when calling ConversationsApi->patch_emails_email_id: #{e}"
|
2697
|
+
end
|
2698
|
+
~~~
|
2699
|
+
|
2700
|
+
### Parameters
|
2701
|
+
|
2702
|
+
Name | Type | Description | Notes
|
2703
|
+
------------- | ------------- | ------------- | -------------
|
2704
|
+
**email_id** | **String**| |
|
2705
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
2706
|
+
{: class="table table-striped"}
|
2707
|
+
|
2708
|
+
|
2709
|
+
### Return type
|
2710
|
+
|
2711
|
+
[**Conversation**](Conversation.html)
|
2712
|
+
|
2713
|
+
### HTTP request headers
|
2714
|
+
|
2715
|
+
- **Content-Type**: application/json
|
2716
|
+
- **Accept**: application/json
|
2717
|
+
|
2718
|
+
|
2719
|
+
|
2345
2720
|
<a name="patch_emails_email_id_participants_participant_id"></a>
|
2346
2721
|
|
2347
2722
|
## - patch_emails_email_id_participants_participant_id(email_id, participant_id, body)
|