purecloud 0.60.1 → 0.61.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +1 -1
- data/doc_out/AttemptLimitsEntityListing.html.md +1 -1
- data/doc_out/AttributeEntityListing.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/ChatConversationEntityListing.html.md +1 -1
- data/doc_out/CobrowseConversationEntityListing.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +1 -1
- data/doc_out/ContactListEntityListing.html.md +1 -1
- data/doc_out/ConversationEntityListing.html.md +1 -1
- data/doc_out/CopyVoicemailMessage.html.md +15 -0
- data/doc_out/DIDEntityListing.html.md +1 -1
- data/doc_out/DIDPoolEntityListing.html.md +1 -1
- data/doc_out/DecisionsDownloadLink.html.md +14 -0
- data/doc_out/DecisionsDownloadMetadata.html.md +20 -0
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +22 -0
- 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/DomainEdgeSoftwareVersionDtoEntityListing.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/Edge.html.md +2 -0
- 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/ForecastSearchCriteria.html.md +20 -0
- data/doc_out/ForecastSearchRequest.html.md +20 -0
- data/doc_out/GreetingListing.html.md +22 -0
- data/doc_out/GreetingsApi.html.md +240 -0
- data/doc_out/GroupEntityListing.html.md +1 -1
- data/doc_out/HeartBeatAlertContainer.html.md +1 -1
- data/doc_out/HeartBeatRuleContainer.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/KeywordSetEntityListing.html.md +1 -1
- data/doc_out/LanguageEntityListing.html.md +1 -1
- data/doc_out/LanguagesApi.html.md +123 -70
- data/doc_out/LibraryEntityListing.html.md +1 -1
- data/doc_out/Line.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +1 -1
- data/doc_out/LineEntityListing.html.md +1 -1
- data/doc_out/LocalEncryptionConfigurationListing.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/OutboundApi.html.md +3 -1
- data/doc_out/OutboundRouteEntityListing.html.md +1 -1
- data/doc_out/Participant.html.md +1 -0
- data/doc_out/PermissionCollectionEntityListing.html.md +1 -1
- data/doc_out/Phone.html.md +2 -0
- 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/QueueMemberEntityListing.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/RoutingApi.html.md +121 -0
- data/doc_out/RoutingStatusAlertContainer.html.md +1 -1
- data/doc_out/RoutingStatusRuleContainer.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/ScreenRecordingSessionListing.html.md +1 -1
- data/doc_out/ScriptEntityListing.html.md +1 -1
- data/doc_out/SearchApi.html.md +122 -2
- 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/SuggestApi.html.md +4 -2
- data/doc_out/SuggestSearchRequest.html.md +1 -0
- data/doc_out/TagValueEntityListing.html.md +1 -1
- data/doc_out/TelephonyProvidersEdgeApi.html.md +19 -5
- data/doc_out/TimeZoneEntityListing.html.md +1 -1
- data/doc_out/TrunkBaseEntityListing.html.md +1 -1
- data/doc_out/TrunkEntityListing.html.md +1 -1
- data/doc_out/TrunkMetabaseEntityListing.html.md +1 -1
- data/doc_out/UserEntityListing.html.md +1 -1
- data/doc_out/UserPresenceAlertContainer.html.md +1 -1
- data/doc_out/UserPresenceRuleContainer.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/VoicemailApi.html.md +649 -10
- data/doc_out/VoicemailGroupPolicy.html.md +16 -0
- data/doc_out/VoicemailMailboxInfo.html.md +6 -6
- data/doc_out/VoicemailMessage.html.md +13 -9
- data/doc_out/VoicemailMessageEntityListing.html.md +8 -1
- data/doc_out/VoicemailOrganizationPolicy.html.md +1 -0
- data/doc_out/VoicemailSearchCriteria.html.md +20 -0
- data/doc_out/VoicemailSearchRequest.html.md +19 -0
- data/doc_out/VoicemailsSearchResponse.html.md +21 -0
- data/doc_out/WorkforceManagementApi.html.md +118 -0
- 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.rb +11 -0
- data/lib/purecloud/api/greetings_api.rb +256 -0
- data/lib/purecloud/api/languages_api.rb +134 -80
- data/lib/purecloud/api/outbound_api.rb +3 -0
- data/lib/purecloud/api/routing_api.rb +131 -0
- data/lib/purecloud/api/search_api.rb +129 -2
- data/lib/purecloud/api/suggest_api.rb +5 -2
- data/lib/purecloud/api/telephony_providers_edge_api.rb +18 -0
- data/lib/purecloud/api/voicemail_api.rb +674 -8
- data/lib/purecloud/api/workforce_management_api.rb +123 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
- data/lib/purecloud/models/analytics_conversation_segment.rb +1 -1
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +11 -11
- data/lib/purecloud/models/attribute_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/chat_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/cobrowse_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_entity_listing.rb +11 -11
- data/lib/purecloud/models/copy_voicemail_message.rb +189 -0
- data/lib/purecloud/models/decisions_download_link.rb +177 -0
- data/lib/purecloud/models/decisions_download_metadata.rb +242 -0
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +257 -0
- 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_edge_software_version_dto_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.rb +30 -1
- 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/forecast_search_criteria.rb +267 -0
- data/lib/purecloud/models/forecast_search_request.rb +259 -0
- data/lib/purecloud/models/greeting_listing.rb +257 -0
- data/lib/purecloud/models/group_entity_listing.rb +11 -11
- data/lib/purecloud/models/heart_beat_alert_container.rb +11 -11
- data/lib/purecloud/models/heart_beat_rule_container.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/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.rb +2 -0
- 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/local_encryption_configuration_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/participant.rb +12 -1
- data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone.rb +21 -1
- 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/queue_member_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/routing_status_alert_container.rb +11 -11
- data/lib/purecloud/models/routing_status_rule_container.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/screen_recording_session_listing.rb +11 -11
- data/lib/purecloud/models/script_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/suggest_search_request.rb +14 -1
- 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_base_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_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_presence_alert_container.rb +11 -11
- data/lib/purecloud/models/user_presence_rule_container.rb +11 -11
- 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/voicemail_group_policy.rb +202 -0
- data/lib/purecloud/models/voicemail_mailbox_info.rb +13 -9
- data/lib/purecloud/models/voicemail_message.rb +56 -3
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +83 -13
- data/lib/purecloud/models/voicemail_organization_policy.rb +17 -4
- data/lib/purecloud/models/voicemail_search_criteria.rb +267 -0
- data/lib/purecloud/models/voicemail_search_request.rb +246 -0
- data/lib/purecloud/models/voicemails_search_response.rb +258 -0
- 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 +24 -2
|
@@ -11,8 +11,8 @@ title: EmailMessageListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EncryptionKeyEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EndpointEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EvaluationEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EvaluationFormEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EvaluatorActivityEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: ExtensionEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: ExtensionPoolEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: FaxDocumentEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ForecastSearchCriteria
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ForecastSearchCriteria
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **end_value** | **String** | The end value of the range. This field is used for range search types. | [optional] |
|
|
11
|
+
| **values** | **Array<String>** | A list of values for the search to match against | [optional] |
|
|
12
|
+
| **start_value** | **String** | The start value of the range. This field is used for range search types. | [optional] |
|
|
13
|
+
| **fields** | **Array<String>** | Field names to search against | [optional] |
|
|
14
|
+
| **value** | **String** | A value for the search to match against | [optional] |
|
|
15
|
+
| **operator** | **String** | How to apply this search criteria against other criteria | [optional] |
|
|
16
|
+
| **group** | [**Array<ForecastSearchCriteria>**](ForecastSearchCriteria.html) | Groups multiple conditions | [optional] |
|
|
17
|
+
| **type** | **String** | Search Type | |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ForecastSearchRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ForecastSearchRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **sort_order** | **String** | The sort order for results | [optional] |
|
|
11
|
+
| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | The number of results per page | [optional] |
|
|
13
|
+
| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
|
|
14
|
+
| **return_fields** | **Array<String>** | A List of strings containing the resource field paths that you want to return | [optional] |
|
|
15
|
+
| **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
|
|
16
|
+
| **types** | **Array<String>** | Resource type | |
|
|
17
|
+
| **query** | [**Array<ForecastSearchCriteria>**](ForecastSearchCriteria.html) | | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: GreetingListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::GreetingListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<Greeting>**](Greeting.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -13,12 +13,16 @@ Method | HTTP request | Description
|
|
|
13
13
|
|[**get_greeting_id**](GreetingsApi.html#get_greeting_id) | **GET** /api/v2/greetings/{greetingId} | Get a Greeting with the given GreetingId|
|
|
14
14
|
|[**get_greeting_id_media**](GreetingsApi.html#get_greeting_id_media) | **GET** /api/v2/greetings/{greetingId}/media | Get media playback URI for this greeting|
|
|
15
15
|
|[**get_greetings**](GreetingsApi.html#get_greetings) | **GET** /api/v2/greetings | Gets an Organization's Greetings|
|
|
16
|
+
|[**get_group_id_greetings**](GreetingsApi.html#get_group_id_greetings) | **GET** /api/v2/groups/{groupId}/greetings | Get a list of the Group's Greetings|
|
|
17
|
+
|[**get_group_id_greetings_defaults**](GreetingsApi.html#get_group_id_greetings_defaults) | **GET** /api/v2/groups/{groupId}/greetings/defaults | Grabs the list of Default Greetings given a Group's ID|
|
|
16
18
|
|[**get_user_id_greetings**](GreetingsApi.html#get_user_id_greetings) | **GET** /api/v2/users/{userId}/greetings | Get a list of the User's Greetings|
|
|
17
19
|
|[**get_user_id_greetings_defaults**](GreetingsApi.html#get_user_id_greetings_defaults) | **GET** /api/v2/users/{userId}/greetings/defaults | Grabs the list of Default Greetings given a User's ID|
|
|
18
20
|
|[**post_greetings**](GreetingsApi.html#post_greetings) | **POST** /api/v2/greetings | Create a Greeting for an Organization|
|
|
21
|
+
|[**post_group_id_greetings**](GreetingsApi.html#post_group_id_greetings) | **POST** /api/v2/groups/{groupId}/greetings | Creates a Greeting for a Group|
|
|
19
22
|
|[**post_user_id_greetings**](GreetingsApi.html#post_user_id_greetings) | **POST** /api/v2/users/{userId}/greetings | Creates a Greeting for a User|
|
|
20
23
|
|[**put_defaults**](GreetingsApi.html#put_defaults) | **PUT** /api/v2/greetings/defaults | Update an Organization's DefaultGreetingList|
|
|
21
24
|
|[**put_greeting_id**](GreetingsApi.html#put_greeting_id) | **PUT** /api/v2/greetings/{greetingId} | Updates the Greeting with the given GreetingId|
|
|
25
|
+
|[**put_group_id_greetings_defaults**](GreetingsApi.html#put_group_id_greetings_defaults) | **PUT** /api/v2/groups/{groupId}/greetings/defaults | Updates the DefaultGreetingList of the specified Group|
|
|
22
26
|
|[**put_user_id_greetings_defaults**](GreetingsApi.html#put_user_id_greetings_defaults) | **PUT** /api/v2/users/{userId}/greetings/defaults | Updates the DefaultGreetingList of the specified User|
|
|
23
27
|
{: class="table table-striped"}
|
|
24
28
|
|
|
@@ -303,6 +307,124 @@ Name | Type | Description | Notes
|
|
|
303
307
|
|
|
304
308
|
|
|
305
309
|
|
|
310
|
+
<a name="get_group_id_greetings"></a>
|
|
311
|
+
|
|
312
|
+
## -[**GreetingListing**](GreetingListing.html) get_group_id_greetings(group_id, opts)
|
|
313
|
+
|
|
314
|
+
Get a list of the Group's Greetings
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
### Example
|
|
319
|
+
~~~ruby
|
|
320
|
+
# load the gem
|
|
321
|
+
require 'purecloud'
|
|
322
|
+
# setup authorization
|
|
323
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
324
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
325
|
+
environment = "mypurecloud.com"
|
|
326
|
+
|
|
327
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
328
|
+
|
|
329
|
+
PureCloud.configure do |config|
|
|
330
|
+
config.access_token = @authToken
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
api_instance = PureCloud::GreetingsApi.new
|
|
334
|
+
|
|
335
|
+
group_id = "group_id_example" # String | Group ID
|
|
336
|
+
|
|
337
|
+
opts = {
|
|
338
|
+
page_size: 25, # Integer | Page size
|
|
339
|
+
page_number: 1 # Integer | Page number
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
begin
|
|
343
|
+
#Get a list of the Group's Greetings
|
|
344
|
+
result = api_instance.get_group_id_greetings(group_id, opts)
|
|
345
|
+
p result
|
|
346
|
+
rescue PureCloud::ApiError => e
|
|
347
|
+
puts "Exception when calling GreetingsApi->get_group_id_greetings: #{e}"
|
|
348
|
+
end
|
|
349
|
+
~~~
|
|
350
|
+
|
|
351
|
+
### Parameters
|
|
352
|
+
|
|
353
|
+
Name | Type | Description | Notes
|
|
354
|
+
------------- | ------------- | ------------- | -------------
|
|
355
|
+
**group_id** | **String**| Group ID |
|
|
356
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
357
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
358
|
+
{: class="table table-striped"}
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
### Return type
|
|
362
|
+
|
|
363
|
+
[**GreetingListing**](GreetingListing.html)
|
|
364
|
+
|
|
365
|
+
### HTTP request headers
|
|
366
|
+
|
|
367
|
+
- **Content-Type**: application/json
|
|
368
|
+
- **Accept**: application/json
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<a name="get_group_id_greetings_defaults"></a>
|
|
373
|
+
|
|
374
|
+
## -[**DefaultGreetingList**](DefaultGreetingList.html) get_group_id_greetings_defaults(group_id)
|
|
375
|
+
|
|
376
|
+
Grabs the list of Default Greetings given a Group's ID
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
### Example
|
|
381
|
+
~~~ruby
|
|
382
|
+
# load the gem
|
|
383
|
+
require 'purecloud'
|
|
384
|
+
# setup authorization
|
|
385
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
386
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
387
|
+
environment = "mypurecloud.com"
|
|
388
|
+
|
|
389
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
390
|
+
|
|
391
|
+
PureCloud.configure do |config|
|
|
392
|
+
config.access_token = @authToken
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
api_instance = PureCloud::GreetingsApi.new
|
|
396
|
+
|
|
397
|
+
group_id = "group_id_example" # String | Group ID
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
begin
|
|
401
|
+
#Grabs the list of Default Greetings given a Group's ID
|
|
402
|
+
result = api_instance.get_group_id_greetings_defaults(group_id)
|
|
403
|
+
p result
|
|
404
|
+
rescue PureCloud::ApiError => e
|
|
405
|
+
puts "Exception when calling GreetingsApi->get_group_id_greetings_defaults: #{e}"
|
|
406
|
+
end
|
|
407
|
+
~~~
|
|
408
|
+
|
|
409
|
+
### Parameters
|
|
410
|
+
|
|
411
|
+
Name | Type | Description | Notes
|
|
412
|
+
------------- | ------------- | ------------- | -------------
|
|
413
|
+
**group_id** | **String**| Group ID |
|
|
414
|
+
{: class="table table-striped"}
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
### Return type
|
|
418
|
+
|
|
419
|
+
[**DefaultGreetingList**](DefaultGreetingList.html)
|
|
420
|
+
|
|
421
|
+
### HTTP request headers
|
|
422
|
+
|
|
423
|
+
- **Content-Type**: application/json
|
|
424
|
+
- **Accept**: application/json
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
306
428
|
<a name="get_user_id_greetings"></a>
|
|
307
429
|
|
|
308
430
|
## -[**DomainEntityListing**](DomainEntityListing.html) get_user_id_greetings(user_id, opts)
|
|
@@ -477,6 +599,65 @@ Name | Type | Description | Notes
|
|
|
477
599
|
|
|
478
600
|
|
|
479
601
|
|
|
602
|
+
<a name="post_group_id_greetings"></a>
|
|
603
|
+
|
|
604
|
+
## -[**Greeting**](Greeting.html) post_group_id_greetings(group_id, body)
|
|
605
|
+
|
|
606
|
+
Creates a Greeting for a Group
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
### Example
|
|
611
|
+
~~~ruby
|
|
612
|
+
# load the gem
|
|
613
|
+
require 'purecloud'
|
|
614
|
+
# setup authorization
|
|
615
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
616
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
617
|
+
environment = "mypurecloud.com"
|
|
618
|
+
|
|
619
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
620
|
+
|
|
621
|
+
PureCloud.configure do |config|
|
|
622
|
+
config.access_token = @authToken
|
|
623
|
+
end
|
|
624
|
+
|
|
625
|
+
api_instance = PureCloud::GreetingsApi.new
|
|
626
|
+
|
|
627
|
+
group_id = "group_id_example" # String | Group ID
|
|
628
|
+
|
|
629
|
+
body = PureCloud::Greeting.new # Greeting | The Greeting to create
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
begin
|
|
633
|
+
#Creates a Greeting for a Group
|
|
634
|
+
result = api_instance.post_group_id_greetings(group_id, body)
|
|
635
|
+
p result
|
|
636
|
+
rescue PureCloud::ApiError => e
|
|
637
|
+
puts "Exception when calling GreetingsApi->post_group_id_greetings: #{e}"
|
|
638
|
+
end
|
|
639
|
+
~~~
|
|
640
|
+
|
|
641
|
+
### Parameters
|
|
642
|
+
|
|
643
|
+
Name | Type | Description | Notes
|
|
644
|
+
------------- | ------------- | ------------- | -------------
|
|
645
|
+
**group_id** | **String**| Group ID |
|
|
646
|
+
**body** | [**Greeting**](Greeting.html)| The Greeting to create |
|
|
647
|
+
{: class="table table-striped"}
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
### Return type
|
|
651
|
+
|
|
652
|
+
[**Greeting**](Greeting.html)
|
|
653
|
+
|
|
654
|
+
### HTTP request headers
|
|
655
|
+
|
|
656
|
+
- **Content-Type**: application/json
|
|
657
|
+
- **Accept**: application/json
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
480
661
|
<a name="post_user_id_greetings"></a>
|
|
481
662
|
|
|
482
663
|
## -[**Greeting**](Greeting.html) post_user_id_greetings(user_id, body)
|
|
@@ -651,6 +832,65 @@ Name | Type | Description | Notes
|
|
|
651
832
|
|
|
652
833
|
|
|
653
834
|
|
|
835
|
+
<a name="put_group_id_greetings_defaults"></a>
|
|
836
|
+
|
|
837
|
+
## -[**DefaultGreetingList**](DefaultGreetingList.html) put_group_id_greetings_defaults(group_id, body)
|
|
838
|
+
|
|
839
|
+
Updates the DefaultGreetingList of the specified Group
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
### Example
|
|
844
|
+
~~~ruby
|
|
845
|
+
# load the gem
|
|
846
|
+
require 'purecloud'
|
|
847
|
+
# setup authorization
|
|
848
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
849
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
850
|
+
environment = "mypurecloud.com"
|
|
851
|
+
|
|
852
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
853
|
+
|
|
854
|
+
PureCloud.configure do |config|
|
|
855
|
+
config.access_token = @authToken
|
|
856
|
+
end
|
|
857
|
+
|
|
858
|
+
api_instance = PureCloud::GreetingsApi.new
|
|
859
|
+
|
|
860
|
+
group_id = "group_id_example" # String | Group ID
|
|
861
|
+
|
|
862
|
+
body = PureCloud::DefaultGreetingList.new # DefaultGreetingList | The updated defaultGreetingList
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
begin
|
|
866
|
+
#Updates the DefaultGreetingList of the specified Group
|
|
867
|
+
result = api_instance.put_group_id_greetings_defaults(group_id, body)
|
|
868
|
+
p result
|
|
869
|
+
rescue PureCloud::ApiError => e
|
|
870
|
+
puts "Exception when calling GreetingsApi->put_group_id_greetings_defaults: #{e}"
|
|
871
|
+
end
|
|
872
|
+
~~~
|
|
873
|
+
|
|
874
|
+
### Parameters
|
|
875
|
+
|
|
876
|
+
Name | Type | Description | Notes
|
|
877
|
+
------------- | ------------- | ------------- | -------------
|
|
878
|
+
**group_id** | **String**| Group ID |
|
|
879
|
+
**body** | [**DefaultGreetingList**](DefaultGreetingList.html)| The updated defaultGreetingList |
|
|
880
|
+
{: class="table table-striped"}
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
### Return type
|
|
884
|
+
|
|
885
|
+
[**DefaultGreetingList**](DefaultGreetingList.html)
|
|
886
|
+
|
|
887
|
+
### HTTP request headers
|
|
888
|
+
|
|
889
|
+
- **Content-Type**: application/json
|
|
890
|
+
- **Accept**: application/json
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
654
894
|
<a name="put_user_id_greetings_defaults"></a>
|
|
655
895
|
|
|
656
896
|
## -[**DefaultGreetingList**](DefaultGreetingList.html) put_user_id_greetings_defaults(user_id, body)
|
|
@@ -11,8 +11,8 @@ title: GroupEntityListing
|
|
|
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
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|