purecloud 0.66.1 → 0.67.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 +3 -3
- data/doc_out/AttemptLimitsEntityListing.html.md +3 -3
- data/doc_out/AttributeEntityListing.html.md +3 -3
- data/doc_out/CalibrationEntityListing.html.md +3 -3
- data/doc_out/CallConversationEntityListing.html.md +3 -3
- data/doc_out/CallableTimeSetEntityListing.html.md +3 -3
- data/doc_out/CallbackConversationEntityListing.html.md +3 -3
- data/doc_out/CampaignEntityListing.html.md +3 -3
- data/doc_out/CampaignInteractions.html.md +1 -0
- data/doc_out/CampaignRuleEntityListing.html.md +3 -3
- data/doc_out/CampaignSequenceEntityListing.html.md +3 -3
- data/doc_out/CertificateAuthorityEntityListing.html.md +3 -3
- data/doc_out/ChannelEntityListing.html.md +3 -3
- data/doc_out/ChatConversationEntityListing.html.md +3 -3
- data/doc_out/CobrowseConversationEntityListing.html.md +3 -3
- data/doc_out/CommandStatusEntityListing.html.md +3 -3
- data/doc_out/ContactListEntityListing.html.md +3 -3
- data/doc_out/ContentManagementApi.html.md +4 -3
- data/doc_out/ConversationEntityListing.html.md +3 -3
- data/doc_out/ConversationsApi.html.md +20 -15
- data/doc_out/DIDEntityListing.html.md +3 -3
- data/doc_out/DIDPoolEntityListing.html.md +3 -3
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +3 -3
- data/doc_out/DncListEntityListing.html.md +3 -3
- data/doc_out/Document.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +3 -3
- data/doc_out/DocumentEntityListing.html.md +3 -3
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +3 -3
- data/doc_out/DomainEntityListing.html.md +3 -3
- data/doc_out/DomainEntityListingEvaluationForm.html.md +3 -3
- data/doc_out/DomainEntityListingQueryResult.html.md +3 -3
- data/doc_out/EdgeEntityListing.html.md +3 -3
- data/doc_out/EdgeGroupEntityListing.html.md +3 -3
- data/doc_out/EdgeLineEntityListing.html.md +3 -3
- data/doc_out/EdgeMetrics.html.md +20 -0
- data/doc_out/EdgeMetricsDisk.html.md +15 -0
- data/doc_out/EdgeMetricsMemory.html.md +15 -0
- data/doc_out/EdgeMetricsNetwork.html.md +17 -0
- data/doc_out/EdgeMetricsProcessor.html.md +17 -0
- data/doc_out/EdgeMetricsSubsystem.html.md +15 -0
- data/doc_out/EmailConversationEntityListing.html.md +3 -3
- data/doc_out/EmailMessageListing.html.md +3 -3
- data/doc_out/Empty.html.md +12 -0
- data/doc_out/EncryptionKeyEntityListing.html.md +3 -3
- data/doc_out/EndpointEntityListing.html.md +3 -3
- data/doc_out/EvaluationEntityListing.html.md +3 -3
- data/doc_out/EvaluationFormEntityListing.html.md +3 -3
- data/doc_out/EvaluatorActivityEntityListing.html.md +3 -3
- data/doc_out/ExtensionEntityListing.html.md +3 -3
- data/doc_out/ExtensionPoolEntityListing.html.md +3 -3
- data/doc_out/FaxDocument.html.md +1 -1
- data/doc_out/FaxDocumentEntityListing.html.md +3 -3
- data/doc_out/FieldConfigs.html.md +16 -0
- data/doc_out/GreetingListing.html.md +3 -3
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupContact.html.md +16 -0
- data/doc_out/GroupEntityListing.html.md +3 -3
- data/doc_out/GroupUpdate.html.md +1 -1
- data/doc_out/GroupsApi.html.md +8 -6
- data/doc_out/HeartBeatAlertContainer.html.md +3 -3
- data/doc_out/HeartBeatRuleContainer.html.md +3 -3
- data/doc_out/InboundDomainEntityListing.html.md +3 -3
- data/doc_out/InboundRouteEntityListing.html.md +3 -3
- data/doc_out/InteractionStatsAlertContainer.html.md +3 -3
- data/doc_out/InteractionStatsRuleContainer.html.md +3 -3
- data/doc_out/KeywordSetEntityListing.html.md +3 -3
- data/doc_out/LanguageEntityListing.html.md +3 -3
- data/doc_out/LibraryEntityListing.html.md +3 -3
- data/doc_out/LineBaseEntityListing.html.md +3 -3
- data/doc_out/LineEntityListing.html.md +3 -3
- data/doc_out/LocalEncryptionConfigurationListing.html.md +3 -3
- data/doc_out/LogicalInterfaceEntityListing.html.md +3 -3
- data/doc_out/OAuthClientEntityListing.html.md +3 -3
- data/doc_out/OAuthProviderEntityListing.html.md +3 -3
- data/doc_out/OrganizationPresenceEntityListing.html.md +3 -3
- data/doc_out/OrganizationRoleEntityListing.html.md +3 -3
- data/doc_out/OrphanRecordingListing.html.md +3 -3
- data/doc_out/OutboundApi.html.md +3 -4
- data/doc_out/OutboundRouteBaseEntityListing.html.md +3 -3
- data/doc_out/OutboundRouteEntityListing.html.md +3 -3
- data/doc_out/PermissionCollectionEntityListing.html.md +3 -3
- data/doc_out/PhoneBaseEntityListing.html.md +3 -3
- data/doc_out/PhoneEntityListing.html.md +3 -3
- data/doc_out/PhoneMetaBaseEntityListing.html.md +3 -3
- data/doc_out/PhysicalInterfaceEntityListing.html.md +3 -3
- data/doc_out/PolicyEntityListing.html.md +3 -3
- data/doc_out/QualityAuditPage.html.md +3 -3
- data/doc_out/QueueEntityListing.html.md +3 -3
- data/doc_out/QueueMemberEntityListing.html.md +3 -3
- data/doc_out/ReportMetaDataEntityListing.html.md +3 -3
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +3 -3
- data/doc_out/ReportScheduleEntityListing.html.md +3 -3
- data/doc_out/ResponseEntityList.html.md +3 -3
- data/doc_out/ResponseEntityListing.html.md +3 -3
- data/doc_out/ResponseSetEntityListing.html.md +3 -3
- data/doc_out/RoutingStatusAlertContainer.html.md +3 -3
- data/doc_out/RoutingStatusRuleContainer.html.md +3 -3
- data/doc_out/RuleSetEntityListing.html.md +3 -3
- data/doc_out/SchemaCategoryEntityListing.html.md +3 -3
- data/doc_out/SchemaReferenceEntityListing.html.md +3 -3
- data/doc_out/ScreenRecordingSessionListing.html.md +3 -3
- data/doc_out/ScriptEntityListing.html.md +3 -3
- data/doc_out/SecurityProfileEntityListing.html.md +3 -3
- data/doc_out/ShareEntityListing.html.md +3 -3
- data/doc_out/SharedResponse.html.md +17 -0
- data/doc_out/SiteEntityListing.html.md +3 -3
- data/doc_out/SkillEntityListing.html.md +3 -3
- data/doc_out/StationEntityListing.html.md +3 -3
- data/doc_out/TagValueEntityListing.html.md +3 -3
- data/doc_out/TelephonyProvidersEdgeApi.html.md +117 -1
- data/doc_out/TimeZoneEntityListing.html.md +3 -3
- data/doc_out/TrunkBaseEntityListing.html.md +3 -3
- data/doc_out/TrunkEntityListing.html.md +3 -3
- data/doc_out/TrunkMetabaseEntityListing.html.md +3 -3
- data/doc_out/UserEntityListing.html.md +3 -3
- data/doc_out/UserMe.html.md +1 -0
- data/doc_out/UserPresenceAlertContainer.html.md +3 -3
- data/doc_out/UserPresenceRuleContainer.html.md +3 -3
- data/doc_out/UserQueueEntityListing.html.md +3 -3
- data/doc_out/UserRecordingEntityListing.html.md +3 -3
- data/doc_out/UserSkillEntityListing.html.md +3 -3
- data/doc_out/VoicemailMessageEntityListing.html.md +3 -3
- data/doc_out/VoicemailOrganizationPolicy.html.md +4 -13
- data/doc_out/VoicemailUserPolicy.html.md +4 -11
- data/doc_out/WorkforceManagementApi.html.md +4 -4
- data/doc_out/WorkspaceEntityListing.html.md +3 -3
- data/doc_out/WorkspaceMemberEntityListing.html.md +3 -3
- data/doc_out/WrapupCodeEntityListing.html.md +3 -3
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +10 -0
- data/lib/purecloud/api/content_management_api.rb +6 -5
- data/lib/purecloud/api/conversations_api.rb +30 -25
- data/lib/purecloud/api/groups_api.rb +14 -12
- data/lib/purecloud/api/organization_api.rb +2 -2
- data/lib/purecloud/api/outbound_api.rb +5 -6
- data/lib/purecloud/api/telephony_providers_edge_api.rb +124 -0
- data/lib/purecloud/api/users_api.rb +2 -2
- data/lib/purecloud/api/workforce_management_api.rb +5 -5
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +23 -23
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +23 -23
- data/lib/purecloud/models/attribute_entity_listing.rb +23 -23
- data/lib/purecloud/models/calibration_entity_listing.rb +23 -23
- data/lib/purecloud/models/call.rb +1 -1
- data/lib/purecloud/models/call_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/callback.rb +1 -1
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_interactions.rb +16 -4
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +23 -23
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +23 -23
- data/lib/purecloud/models/channel_entity_listing.rb +23 -23
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/cobrowsesession.rb +1 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +23 -23
- data/lib/purecloud/models/contact_list_entity_listing.rb +23 -23
- data/lib/purecloud/models/conversation_chat.rb +1 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +23 -23
- data/lib/purecloud/models/did_entity_listing.rb +23 -23
- data/lib/purecloud/models/did_pool_entity_listing.rb +23 -23
- data/lib/purecloud/models/dnc_list_entity_listing.rb +23 -23
- data/lib/purecloud/models/document.rb +11 -11
- data/lib/purecloud/models/document_audit_entity_listing.rb +23 -23
- data/lib/purecloud/models/document_entity_listing.rb +23 -23
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +23 -23
- data/lib/purecloud/models/edge_entity_listing.rb +23 -23
- data/lib/purecloud/models/edge_group_entity_listing.rb +23 -23
- data/lib/purecloud/models/edge_line_entity_listing.rb +23 -23
- data/lib/purecloud/models/edge_metrics.rb +246 -0
- data/lib/purecloud/models/edge_metrics_disk.rb +188 -0
- data/lib/purecloud/models/edge_metrics_memory.rb +188 -0
- data/lib/purecloud/models/edge_metrics_network.rb +210 -0
- data/lib/purecloud/models/edge_metrics_processor.rb +210 -0
- data/lib/purecloud/models/edge_metrics_subsystem.rb +188 -0
- data/lib/purecloud/models/email.rb +1 -1
- data/lib/purecloud/models/email_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/email_message_listing.rb +23 -23
- data/lib/purecloud/models/empty.rb +155 -0
- data/lib/purecloud/models/encryption_key_entity_listing.rb +23 -23
- data/lib/purecloud/models/endpoint_entity_listing.rb +23 -23
- data/lib/purecloud/models/evaluation_entity_listing.rb +23 -23
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +23 -23
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +23 -23
- data/lib/purecloud/models/extension_entity_listing.rb +23 -23
- data/lib/purecloud/models/extension_pool_entity_listing.rb +23 -23
- data/lib/purecloud/models/fax_document.rb +11 -11
- data/lib/purecloud/models/fax_document_entity_listing.rb +23 -23
- data/lib/purecloud/models/field_config.rb +1 -1
- data/lib/purecloud/models/field_configs.rb +195 -0
- data/lib/purecloud/models/greeting_listing.rb +23 -23
- data/lib/purecloud/models/group.rb +1 -1
- data/lib/purecloud/models/group_contact.rb +217 -0
- data/lib/purecloud/models/group_entity_listing.rb +23 -23
- data/lib/purecloud/models/group_update.rb +1 -1
- data/lib/purecloud/models/heart_beat_alert_container.rb +23 -23
- data/lib/purecloud/models/heart_beat_rule_container.rb +23 -23
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +23 -23
- data/lib/purecloud/models/inbound_route_entity_listing.rb +23 -23
- data/lib/purecloud/models/interaction_stats_alert_container.rb +23 -23
- data/lib/purecloud/models/interaction_stats_rule_container.rb +23 -23
- data/lib/purecloud/models/keyword_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/language_entity_listing.rb +23 -23
- data/lib/purecloud/models/library_entity_listing.rb +23 -23
- data/lib/purecloud/models/line_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/line_entity_listing.rb +23 -23
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +23 -23
- data/lib/purecloud/models/logical_interface_entity_listing.rb +23 -23
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +23 -23
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +23 -23
- data/lib/purecloud/models/organization_presence_entity_listing.rb +23 -23
- data/lib/purecloud/models/organization_role_entity_listing.rb +23 -23
- data/lib/purecloud/models/orphan_recording_listing.rb +23 -23
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/outbound_route_entity_listing.rb +23 -23
- data/lib/purecloud/models/permission_collection_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/physical_interface_entity_listing.rb +23 -23
- data/lib/purecloud/models/policy_entity_listing.rb +23 -23
- data/lib/purecloud/models/quality_audit_page.rb +23 -23
- data/lib/purecloud/models/queue_entity_listing.rb +23 -23
- data/lib/purecloud/models/queue_member_entity_listing.rb +23 -23
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +23 -23
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +23 -23
- data/lib/purecloud/models/report_schedule_entity_listing.rb +23 -23
- data/lib/purecloud/models/response_entity_list.rb +23 -23
- data/lib/purecloud/models/response_entity_listing.rb +23 -23
- data/lib/purecloud/models/response_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/routing_status_alert_container.rb +23 -23
- data/lib/purecloud/models/routing_status_rule_container.rb +23 -23
- data/lib/purecloud/models/rule_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/schema_category_entity_listing.rb +23 -23
- data/lib/purecloud/models/schema_reference_entity_listing.rb +23 -23
- data/lib/purecloud/models/screen_recording_session_listing.rb +23 -23
- data/lib/purecloud/models/screenshare.rb +1 -1
- data/lib/purecloud/models/script_entity_listing.rb +23 -23
- data/lib/purecloud/models/security_profile_entity_listing.rb +23 -23
- data/lib/purecloud/models/share_entity_listing.rb +23 -23
- data/lib/purecloud/models/shared_response.rb +205 -0
- data/lib/purecloud/models/site_entity_listing.rb +23 -23
- data/lib/purecloud/models/skill_entity_listing.rb +23 -23
- data/lib/purecloud/models/social_expression.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +23 -23
- data/lib/purecloud/models/tag_value_entity_listing.rb +23 -23
- data/lib/purecloud/models/time_zone_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_me.rb +12 -1
- data/lib/purecloud/models/user_presence_alert_container.rb +23 -23
- data/lib/purecloud/models/user_presence_rule_container.rb +23 -23
- data/lib/purecloud/models/user_queue_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_recording_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_skill_entity_listing.rb +23 -23
- data/lib/purecloud/models/video.rb +1 -1
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +23 -23
- data/lib/purecloud/models/voicemail_organization_policy.rb +18 -106
- data/lib/purecloud/models/voicemail_user_policy.rb +5 -73
- data/lib/purecloud/models/workspace_entity_listing.rb +23 -23
- data/lib/purecloud/models/workspace_member_entity_listing.rb +23 -23
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +23 -23
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +22 -2
@@ -11,11 +11,11 @@ title: SecurityProfileEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ShareEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: SharedResponse
|
3
|
+
---
|
4
|
+
## PureCloud::SharedResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **download_uri** | **String** | | [optional] |
|
12
|
+
| **view_uri** | **String** | | [optional] |
|
13
|
+
| **document** | [**Document**](Document.html) | | [optional] |
|
14
|
+
| **share** | [**Share**](Share.html) | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -11,11 +11,11 @@ title: SiteEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: SkillEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: StationEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: TagValueEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -36,6 +36,7 @@ Method | HTTP request | Description
|
|
36
36
|
|[**get_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces | Get edge logical interfaces.|
|
37
37
|
|[**get_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces_interface_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} | Get an edge logical interface|
|
38
38
|
|[**get_providers_edges_edge_id_logs_jobs_job_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logs_jobs_job_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId} | Get an Edge logs job.|
|
39
|
+
|[**get_providers_edges_edge_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_metrics) | **GET** /api/v2/telephony/providers/edges/{edgeId}/metrics | Get the edge metrics.|
|
39
40
|
|[**get_providers_edges_edge_id_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces) | **GET** /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces | Retrieve a list of all configured physical interfaces from a specific edge.|
|
40
41
|
|[**get_providers_edges_edge_id_physicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces_interface_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId} | Get edge physical interface.|
|
41
42
|
|[**get_providers_edges_edge_id_setuppackage**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_setuppackage) | **GET** /api/v2/telephony/providers/edges/{edgeId}/setuppackage | Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.|
|
@@ -55,6 +56,7 @@ Method | HTTP request | Description
|
|
55
56
|
|[**get_providers_edges_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines) | **GET** /api/v2/telephony/providers/edges/lines | Get a list of Lines|
|
56
57
|
|[**get_providers_edges_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_line_id) | **GET** /api/v2/telephony/providers/edges/lines/{lineId} | Get a Line by ID|
|
57
58
|
|[**get_providers_edges_lines_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_template) | **GET** /api/v2/telephony/providers/edges/lines/template | Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance|
|
59
|
+
|[**get_providers_edges_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_metrics) | **GET** /api/v2/telephony/providers/edges/metrics | Get the metrics for a list of edges.|
|
58
60
|
|[**get_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes) | **GET** /api/v2/telephony/providers/edges/outboundroutes | Get outbound routes|
|
59
61
|
|[**get_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes_outboundroute_id) | **GET** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Get outbound route|
|
60
62
|
|[**get_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings) | **GET** /api/v2/telephony/providers/edges/phonebasesettings | Get a list of Phone Base Settings objects|
|
@@ -1738,6 +1740,62 @@ Name | Type | Description | Notes
|
|
1738
1740
|
|
1739
1741
|
|
1740
1742
|
|
1743
|
+
<a name="get_providers_edges_edge_id_metrics"></a>
|
1744
|
+
|
1745
|
+
## -[**EdgeMetrics**](EdgeMetrics.html) get_providers_edges_edge_id_metrics(edge_id)
|
1746
|
+
|
1747
|
+
Get the edge metrics.
|
1748
|
+
|
1749
|
+
|
1750
|
+
|
1751
|
+
### Example
|
1752
|
+
~~~ruby
|
1753
|
+
# load the gem
|
1754
|
+
require 'purecloud'
|
1755
|
+
# setup authorization
|
1756
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1757
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1758
|
+
environment = "mypurecloud.com"
|
1759
|
+
|
1760
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1761
|
+
|
1762
|
+
PureCloud.configure do |config|
|
1763
|
+
config.access_token = @authToken
|
1764
|
+
end
|
1765
|
+
|
1766
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
1767
|
+
|
1768
|
+
edge_id = "edge_id_example" # String | Edge Id
|
1769
|
+
|
1770
|
+
|
1771
|
+
begin
|
1772
|
+
#Get the edge metrics.
|
1773
|
+
result = api_instance.get_providers_edges_edge_id_metrics(edge_id)
|
1774
|
+
p result
|
1775
|
+
rescue PureCloud::ApiError => e
|
1776
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_metrics: #{e}"
|
1777
|
+
end
|
1778
|
+
~~~
|
1779
|
+
|
1780
|
+
### Parameters
|
1781
|
+
|
1782
|
+
Name | Type | Description | Notes
|
1783
|
+
------------- | ------------- | ------------- | -------------
|
1784
|
+
**edge_id** | **String**| Edge Id |
|
1785
|
+
{: class="table table-striped"}
|
1786
|
+
|
1787
|
+
|
1788
|
+
### Return type
|
1789
|
+
|
1790
|
+
[**EdgeMetrics**](EdgeMetrics.html)
|
1791
|
+
|
1792
|
+
### HTTP request headers
|
1793
|
+
|
1794
|
+
- **Content-Type**: application/json
|
1795
|
+
- **Accept**: application/json
|
1796
|
+
|
1797
|
+
|
1798
|
+
|
1741
1799
|
<a name="get_providers_edges_edge_id_physicalinterfaces"></a>
|
1742
1800
|
|
1743
1801
|
## -[**PhysicalInterfaceEntityListing**](PhysicalInterfaceEntityListing.html) get_providers_edges_edge_id_physicalinterfaces(edge_id)
|
@@ -2851,6 +2909,62 @@ Name | Type | Description | Notes
|
|
2851
2909
|
|
2852
2910
|
|
2853
2911
|
|
2912
|
+
<a name="get_providers_edges_metrics"></a>
|
2913
|
+
|
2914
|
+
## -[**Array<EdgeMetrics>**](EdgeMetrics.html) get_providers_edges_metrics(edge_ids)
|
2915
|
+
|
2916
|
+
Get the metrics for a list of edges.
|
2917
|
+
|
2918
|
+
|
2919
|
+
|
2920
|
+
### Example
|
2921
|
+
~~~ruby
|
2922
|
+
# load the gem
|
2923
|
+
require 'purecloud'
|
2924
|
+
# setup authorization
|
2925
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2926
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2927
|
+
environment = "mypurecloud.com"
|
2928
|
+
|
2929
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2930
|
+
|
2931
|
+
PureCloud.configure do |config|
|
2932
|
+
config.access_token = @authToken
|
2933
|
+
end
|
2934
|
+
|
2935
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
2936
|
+
|
2937
|
+
edge_ids = "edge_ids_example" # String | Comma separated list of Edge Id's
|
2938
|
+
|
2939
|
+
|
2940
|
+
begin
|
2941
|
+
#Get the metrics for a list of edges.
|
2942
|
+
result = api_instance.get_providers_edges_metrics(edge_ids)
|
2943
|
+
p result
|
2944
|
+
rescue PureCloud::ApiError => e
|
2945
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_metrics: #{e}"
|
2946
|
+
end
|
2947
|
+
~~~
|
2948
|
+
|
2949
|
+
### Parameters
|
2950
|
+
|
2951
|
+
Name | Type | Description | Notes
|
2952
|
+
------------- | ------------- | ------------- | -------------
|
2953
|
+
**edge_ids** | **String**| Comma separated list of Edge Id's |
|
2954
|
+
{: class="table table-striped"}
|
2955
|
+
|
2956
|
+
|
2957
|
+
### Return type
|
2958
|
+
|
2959
|
+
[**Array<EdgeMetrics>**](EdgeMetrics.html)
|
2960
|
+
|
2961
|
+
### HTTP request headers
|
2962
|
+
|
2963
|
+
- **Content-Type**: application/json
|
2964
|
+
- **Accept**: application/json
|
2965
|
+
|
2966
|
+
|
2967
|
+
|
2854
2968
|
<a name="get_providers_edges_outboundroutes"></a>
|
2855
2969
|
|
2856
2970
|
## -[**OutboundRouteEntityListing**](OutboundRouteEntityListing.html) get_providers_edges_outboundroutes(opts)
|
@@ -3001,7 +3115,8 @@ opts = {
|
|
3001
3115
|
page_number: 1, # Integer | Page number
|
3002
3116
|
page_size: 25, # Integer | Page size
|
3003
3117
|
sort_by: "name", # String | Value by which to sort
|
3004
|
-
sort_order: "ASC" # String | Sort order
|
3118
|
+
sort_order: "ASC", # String | Sort order
|
3119
|
+
name: "name_example" # String | Name
|
3005
3120
|
}
|
3006
3121
|
|
3007
3122
|
begin
|
@@ -3021,6 +3136,7 @@ Name | Type | Description | Notes
|
|
3021
3136
|
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
3022
3137
|
**sort_by** | **String**| Value by which to sort | [optional] [default to name]
|
3023
3138
|
**sort_order** | **String**| Sort order | [optional] [default to ASC]
|
3139
|
+
**name** | **String**| Name | [optional]
|
3024
3140
|
{: class="table table-striped"}
|
3025
3141
|
|
3026
3142
|
|
@@ -11,11 +11,11 @@ title: TimeZoneEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: TrunkBaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: TrunkEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: TrunkMetabaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: UserEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/doc_out/UserMe.html.md
CHANGED
@@ -40,6 +40,7 @@ title: UserMe
|
|
40
40
|
| **direct_reports** | [**Array<User>**](User.html) | The first 50 direct reports to this user. | [optional] |
|
41
41
|
| **adjacents** | [**Adjacents**](Adjacents.html) | The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands. | [optional] |
|
42
42
|
| **routing_skills** | [**Array<RoutingSkill>**](RoutingSkill.html) | The first 50 routing skills for user's organizations | [optional] |
|
43
|
+
| **field_configs** | [**FieldConfigs**](FieldConfigs.html) | The field config for all entities types of user's organization | [optional] |
|
43
44
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
44
45
|
{: class="table table-striped"}
|
45
46
|
|
@@ -11,11 +11,11 @@ title: UserPresenceAlertContainer
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: UserPresenceRuleContainer
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: UserQueueEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: UserRecordingEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: UserSkillEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: VoicemailMessageEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|