purecloud 0.54.1 → 0.55.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/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AggregationQuery.html.md +1 -0
- data/doc_out/AnalyticsParticipant.html.md +2 -0
- data/doc_out/AnalyticsQueryClause.html.md +2 -2
- data/doc_out/AnalyticsQueryFilter.html.md +1 -1
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AuthorizationApi.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +65 -0
- data/doc_out/CustomerInteractionCenter.html.md +1 -1
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainOrganizationRole.html.md +2 -2
- data/doc_out/DomainOrganizationRoleCreate.html.md +2 -2
- data/doc_out/DomainOrganizationRoleUpdate.html.md +23 -0
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/FieldConfig.html.md +20 -0
- data/doc_out/FieldList.html.md +21 -0
- data/doc_out/Forecast.html.md +16 -0
- data/doc_out/ForecastCreation.html.md +17 -0
- data/doc_out/ForecastCreationCompletion.html.md +14 -0
- data/doc_out/ForecastDimensions.html.md +15 -0
- data/doc_out/ForecastEntry.html.md +15 -0
- data/doc_out/ForecastFilterAttributes.html.md +15 -0
- data/doc_out/ForecastMetadata.html.md +22 -0
- data/doc_out/ForecastMetadataEntityListing.html.md +22 -0
- data/doc_out/ForecastModification.html.md +27 -0
- data/doc_out/ForecastModificationCreation.html.md +25 -0
- data/doc_out/ForecastSearchCriteria.html.md +20 -0
- data/doc_out/ForecastSearchRequest.html.md +20 -0
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +57 -0
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +4 -4
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/ObservationQuery.html.md +1 -1
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrganizationApi.html.md +57 -0
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PagingSpec.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/Phone.html.md +1 -0
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneStatus.html.md +1 -0
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PropertyIndexRequest.html.md +2 -2
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/Salesforce.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/Section.html.md +16 -0
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialExpression.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +2 -2
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkBaseEntityListing.html.md +22 -0
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserAgentInfo.html.md +15 -0
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +57 -0
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/WorkforceManagementApi.html.md +463 -0
- data/doc_out/Workspace.html.md +1 -1
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMember.html.md +1 -1
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +18 -0
- data/lib/purecloud/api/conversations_api.rb +74 -0
- data/lib/purecloud/api/groups_api.rb +64 -0
- data/lib/purecloud/api/organization_api.rb +64 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -3
- data/lib/purecloud/api/users_api.rb +64 -0
- data/lib/purecloud/api/workforce_management_api.rb +493 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +11 -11
- data/lib/purecloud/models/agent_activity_entity_listing.rb +21 -21
- data/lib/purecloud/models/aggregation_query.rb +12 -1
- data/lib/purecloud/models/analytics_participant.rb +21 -1
- data/lib/purecloud/models/analytics_query_clause.rb +1 -0
- data/lib/purecloud/models/analytics_query_filter.rb +1 -0
- data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
- data/lib/purecloud/models/analytics_session.rb +1 -1
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +21 -21
- data/lib/purecloud/models/attribute_entity_listing.rb +21 -21
- data/lib/purecloud/models/calibration_entity_listing.rb +21 -21
- data/lib/purecloud/models/call_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/campaign_entity_listing.rb +21 -21
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +21 -21
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +21 -21
- data/lib/purecloud/models/channel_entity_listing.rb +21 -21
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/command_status_entity_listing.rb +21 -21
- data/lib/purecloud/models/contact_list_entity_listing.rb +21 -21
- data/lib/purecloud/models/conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/customer_interaction_center.rb +11 -11
- data/lib/purecloud/models/did_entity_listing.rb +21 -21
- data/lib/purecloud/models/did_pool_entity_listing.rb +21 -21
- data/lib/purecloud/models/dnc_list_entity_listing.rb +21 -21
- data/lib/purecloud/models/document_audit_entity_listing.rb +21 -21
- data/lib/purecloud/models/document_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +21 -21
- data/lib/purecloud/models/domain_organization_role.rb +14 -13
- data/lib/purecloud/models/domain_organization_role_create.rb +14 -13
- data/lib/purecloud/models/domain_organization_role_update.rb +279 -0
- data/lib/purecloud/models/edge_entity_listing.rb +21 -21
- data/lib/purecloud/models/edge_group_entity_listing.rb +21 -21
- data/lib/purecloud/models/edge_line_entity_listing.rb +21 -21
- data/lib/purecloud/models/email_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/email_message_listing.rb +21 -21
- data/lib/purecloud/models/encryption_key_entity_listing.rb +21 -21
- data/lib/purecloud/models/endpoint_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluation_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +21 -21
- data/lib/purecloud/models/extension_entity_listing.rb +21 -21
- data/lib/purecloud/models/extension_pool_entity_listing.rb +21 -21
- data/lib/purecloud/models/fax_document_entity_listing.rb +21 -21
- data/lib/purecloud/models/field_config.rb +248 -0
- data/lib/purecloud/models/field_list.rb +255 -0
- data/lib/purecloud/models/forecast.rb +201 -0
- data/lib/purecloud/models/forecast_creation.rb +221 -0
- data/lib/purecloud/models/forecast_creation_completion.rb +186 -0
- data/lib/purecloud/models/forecast_dimensions.rb +197 -0
- data/lib/purecloud/models/forecast_entry.rb +199 -0
- data/lib/purecloud/models/forecast_filter_attributes.rb +191 -0
- data/lib/purecloud/models/forecast_metadata.rb +284 -0
- data/lib/purecloud/models/forecast_metadata_entity_listing.rb +257 -0
- data/lib/purecloud/models/forecast_modification.rb +339 -0
- data/lib/purecloud/models/forecast_modification_creation.rb +317 -0
- data/lib/purecloud/models/forecast_search_criteria.rb +267 -0
- data/lib/purecloud/models/forecast_search_request.rb +259 -0
- data/lib/purecloud/models/group_entity_listing.rb +21 -21
- data/lib/purecloud/models/heart_beat_alert_container.rb +21 -21
- data/lib/purecloud/models/heart_beat_rule_container.rb +21 -21
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +21 -21
- data/lib/purecloud/models/inbound_route_entity_listing.rb +21 -21
- data/lib/purecloud/models/interaction_stats_alert_container.rb +21 -21
- data/lib/purecloud/models/interaction_stats_rule_container.rb +21 -21
- data/lib/purecloud/models/json_node.rb +44 -44
- data/lib/purecloud/models/keyword_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/language_entity_listing.rb +21 -21
- data/lib/purecloud/models/library_entity_listing.rb +21 -21
- data/lib/purecloud/models/line_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/line_entity_listing.rb +21 -21
- data/lib/purecloud/models/logical_interface_entity_listing.rb +21 -21
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +21 -21
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +21 -21
- data/lib/purecloud/models/okta.rb +11 -11
- data/lib/purecloud/models/one_login.rb +11 -11
- data/lib/purecloud/models/organization_presence_entity_listing.rb +21 -21
- data/lib/purecloud/models/organization_role_entity_listing.rb +21 -21
- data/lib/purecloud/models/orphan_recording_listing.rb +21 -21
- data/lib/purecloud/models/outbound_route_entity_listing.rb +21 -21
- data/lib/purecloud/models/permission_collection_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone.rb +12 -1
- data/lib/purecloud/models/phone_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_status.rb +12 -1
- data/lib/purecloud/models/physical_interface_entity_listing.rb +21 -21
- data/lib/purecloud/models/policy_entity_listing.rb +21 -21
- data/lib/purecloud/models/property_index_request.rb +9 -9
- data/lib/purecloud/models/quality_audit_page.rb +21 -21
- data/lib/purecloud/models/queue_entity_listing.rb +21 -21
- data/lib/purecloud/models/queue_member_entity_listing.rb +21 -21
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +21 -21
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +21 -21
- data/lib/purecloud/models/report_schedule_entity_listing.rb +21 -21
- data/lib/purecloud/models/response_entity_list.rb +21 -21
- data/lib/purecloud/models/response_entity_listing.rb +21 -21
- data/lib/purecloud/models/response_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/rule_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/salesforce.rb +11 -11
- data/lib/purecloud/models/schema_category_entity_listing.rb +21 -21
- data/lib/purecloud/models/schema_reference_entity_listing.rb +21 -21
- data/lib/purecloud/models/screen_recording_session_listing.rb +21 -21
- data/lib/purecloud/models/section.rb +197 -0
- data/lib/purecloud/models/security_profile_entity_listing.rb +21 -21
- data/lib/purecloud/models/share_entity_listing.rb +21 -21
- data/lib/purecloud/models/site_entity_listing.rb +21 -21
- data/lib/purecloud/models/skill_entity_listing.rb +21 -21
- data/lib/purecloud/models/social_expression.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +21 -21
- data/lib/purecloud/models/tag_value_entity_listing.rb +21 -21
- data/lib/purecloud/models/time_zone_entity_listing.rb +21 -21
- data/lib/purecloud/models/trunk_base_entity_listing.rb +257 -0
- data/lib/purecloud/models/trunk_entity_listing.rb +21 -21
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_agent_info.rb +188 -0
- data/lib/purecloud/models/user_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_queue_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_recording_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_skill_entity_listing.rb +21 -21
- data/lib/purecloud/models/users_entity_listing.rb +21 -21
- data/lib/purecloud/models/workspace.rb +1 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +21 -21
- data/lib/purecloud/models/workspace_member.rb +1 -0
- data/lib/purecloud/models/workspace_member_entity_listing.rb +21 -21
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +21 -21
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +38 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 42cfd25e052a13a84ed936c21d4b004fb0e69af6
|
4
|
+
data.tar.gz: 882a85e66f72c72ffc2f5fd6d07291cdfd3f7000
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d91f5491c160493efbbd1af6d6ea4a5669679e928f94c3d38dcf275ea0d61841e61fa1e024b64c294adba6fa50c74494b6af20b6dc6e806d3c2a48e1971a1948
|
7
|
+
data.tar.gz: 690c573ee69a45f6a0c96f85bb92e7086d2ef9c7bf451ca9dd797a4a0d69840ce89104851893de635427349e8808c825aecf0bc70e36ea21b24bb11c4b15477f
|
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-10-
|
12
|
+
- Package version: 0.55.1
|
13
|
+
- Build date: 2016-10-24T20:40:37.041Z
|
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.55.1'
|
22
22
|
|
23
23
|
### Install from Git
|
24
24
|
|
data/config-ruby.json
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"gemVersion":"0.
|
1
|
+
{"gemVersion":"0.55.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.55.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
|
data/doc_out/ADFS.html.md
CHANGED
@@ -11,8 +11,8 @@ title: ADFS
|
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **relying_party_identifier** | **String** | | [optional] |
|
13
13
|
| **certificate** | **String** | | [optional] |
|
14
|
-
| **sso_target_uri** | **String** | | [optional] |
|
15
14
|
| **issuer_uri** | **String** | | [optional] |
|
15
|
+
| **sso_target_uri** | **String** | | [optional] |
|
16
16
|
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
18
|
{: class="table table-striped"}
|
@@ -11,11 +11,11 @@ title: AgentActivityEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -9,6 +9,7 @@ title: AggregationQuery
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
11
11
|
| **granularity** | **DateTime** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
12
|
+
| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London | [optional] |
|
12
13
|
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
13
14
|
| **filter** | [**AnalyticsQueryFilter**](AnalyticsQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
14
15
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
@@ -11,6 +11,8 @@ title: AnalyticsParticipant
|
|
11
11
|
| **participant_name** | **String** | | [optional] |
|
12
12
|
| **user_id** | **String** | | [optional] |
|
13
13
|
| **purpose** | **String** | | [optional] |
|
14
|
+
| **external_contact_id** | **String** | | [optional] |
|
15
|
+
| **external_organization_id** | **String** | | [optional] |
|
14
16
|
| **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) | | [optional] |
|
15
17
|
{: class="table table-striped"}
|
16
18
|
|
@@ -7,8 +7,8 @@ title: AnalyticsQueryClause
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **type** | **String** |
|
11
|
-
| **predicates** | [**Array<AnalyticsQueryPredicate>**](AnalyticsQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). These can be one of three types: dimension, property, metric. |
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
11
|
+
| **predicates** | [**Array<AnalyticsQueryPredicate>**](AnalyticsQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). These can be one of three types: dimension, property, metric. | |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
@@ -7,7 +7,7 @@ title: AnalyticsQueryFilter
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **type** | **String** |
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
|
11
11
|
| **clauses** | [**Array<AnalyticsQueryClause>**](AnalyticsQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
12
12
|
| **predicates** | [**Array<AnalyticsQueryPredicate>**](AnalyticsQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). These can be one of three types: dimension, property, metric. | [optional] |
|
13
13
|
{: class="table table-striped"}
|
@@ -11,11 +11,11 @@ title: AttemptLimitsEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: AttributeEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -805,7 +805,7 @@ api_instance = PureCloud::AuthorizationApi.new
|
|
805
805
|
|
806
806
|
role_id = "role_id_example" # String | Role ID
|
807
807
|
|
808
|
-
body = PureCloud::
|
808
|
+
body = PureCloud::DomainOrganizationRoleUpdate.new # DomainOrganizationRoleUpdate | Organization role
|
809
809
|
|
810
810
|
|
811
811
|
begin
|
@@ -822,7 +822,7 @@ end
|
|
822
822
|
Name | Type | Description | Notes
|
823
823
|
------------- | ------------- | ------------- | -------------
|
824
824
|
**role_id** | **String**| Role ID |
|
825
|
-
**body** | [**
|
825
|
+
**body** | [**DomainOrganizationRoleUpdate**](DomainOrganizationRoleUpdate.html)| Organization role |
|
826
826
|
{: class="table table-striped"}
|
827
827
|
|
828
828
|
|
@@ -11,11 +11,11 @@ title: CalibrationEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CallConversationEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CallableTimeSetEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CallbackConversationEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CampaignEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CampaignSequenceEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CertificateAuthorityEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ChannelEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ChatConversationEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CobrowseConversationEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: CommandStatusEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ContactListEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ConversationEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -63,6 +63,7 @@ Method | HTTP request | Description
|
|
63
63
|
|[**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|
|
64
64
|
|[**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|
|
65
65
|
|[**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.|
|
66
|
+
|[**patch_emails_email_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_emails_email_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/emails/{emailId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
66
67
|
|[**post_callbacks**](ConversationsApi.html#post_callbacks) | **POST** /api/v2/conversations/callbacks | Create a Callback|
|
67
68
|
|[**post_callbacks_callback_id_participants_participant_id_replace**](ConversationsApi.html#post_callbacks_callback_id_participants_participant_id_replace) | **POST** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|
68
69
|
|[**post_calls**](ConversationsApi.html#post_calls) | **POST** /api/v2/conversations/calls | Create a call conversation|
|
@@ -3323,6 +3324,70 @@ nil (empty response body)
|
|
3323
3324
|
|
3324
3325
|
|
3325
3326
|
|
3327
|
+
<a name="patch_emails_email_id_participants_participant_id_communications_communication_id"></a>
|
3328
|
+
|
3329
|
+
## - patch_emails_email_id_participants_participant_id_communications_communication_id(email_id, participant_id, communication_id, body)
|
3330
|
+
|
3331
|
+
Update conversation participant's communication by disconnecting it.
|
3332
|
+
|
3333
|
+
|
3334
|
+
|
3335
|
+
### Example
|
3336
|
+
~~~ruby
|
3337
|
+
# load the gem
|
3338
|
+
require 'purecloud'
|
3339
|
+
# setup authorization
|
3340
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3341
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3342
|
+
environment = "mypurecloud.com"
|
3343
|
+
|
3344
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3345
|
+
|
3346
|
+
PureCloud.configure do |config|
|
3347
|
+
config.access_token = @authToken
|
3348
|
+
end
|
3349
|
+
|
3350
|
+
api_instance = PureCloud::ConversationsApi.new
|
3351
|
+
|
3352
|
+
email_id = "email_id_example" # String | emailId
|
3353
|
+
|
3354
|
+
participant_id = "participant_id_example" # String | participantId
|
3355
|
+
|
3356
|
+
communication_id = "communication_id_example" # String | communicationId
|
3357
|
+
|
3358
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
3359
|
+
|
3360
|
+
|
3361
|
+
begin
|
3362
|
+
#Update conversation participant's communication by disconnecting it.
|
3363
|
+
api_instance.patch_emails_email_id_participants_participant_id_communications_communication_id(email_id, participant_id, communication_id, body)
|
3364
|
+
rescue PureCloud::ApiError => e
|
3365
|
+
puts "Exception when calling ConversationsApi->patch_emails_email_id_participants_participant_id_communications_communication_id: #{e}"
|
3366
|
+
end
|
3367
|
+
~~~
|
3368
|
+
|
3369
|
+
### Parameters
|
3370
|
+
|
3371
|
+
Name | Type | Description | Notes
|
3372
|
+
------------- | ------------- | ------------- | -------------
|
3373
|
+
**email_id** | **String**| emailId |
|
3374
|
+
**participant_id** | **String**| participantId |
|
3375
|
+
**communication_id** | **String**| communicationId |
|
3376
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
3377
|
+
{: class="table table-striped"}
|
3378
|
+
|
3379
|
+
|
3380
|
+
### Return type
|
3381
|
+
|
3382
|
+
nil (empty response body)
|
3383
|
+
|
3384
|
+
### HTTP request headers
|
3385
|
+
|
3386
|
+
- **Content-Type**: application/json
|
3387
|
+
- **Accept**: application/json
|
3388
|
+
|
3389
|
+
|
3390
|
+
|
3326
3391
|
<a name="post_callbacks"></a>
|
3327
3392
|
|
3328
3393
|
## -[**CreateCallbackResponse**](CreateCallbackResponse.html) post_callbacks(body)
|
@@ -10,8 +10,8 @@ title: CustomerInteractionCenter
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
|
-
| **sso_target_uri** | **String** | | [optional] |
|
14
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
|
+
| **sso_target_uri** | **String** | | [optional] |
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
17
17
|
{: class="table table-striped"}
|
@@ -11,11 +11,11 @@ title: DIDEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|