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
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: VoicemailGroupPolicy
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::VoicemailGroupPolicy
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **name** | **String** | | [optional] |
|
|
11
|
+
| **group** | [**Group**](Group.html) | The group associated with the policy | [optional] |
|
|
12
|
+
| **enabled** | **BOOLEAN** | Whether voicemail is enabled for the group | [optional] [default to false]|
|
|
13
|
+
| **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent to group members when a new voicemail is received | [optional] [default to false]|
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -7,12 +7,12 @@ title: VoicemailMailboxInfo
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **usage_size_bytes** | **Integer** |
|
|
11
|
-
| **total_count** | **Integer** |
|
|
12
|
-
| **unread_count** | **Integer** |
|
|
13
|
-
| **
|
|
14
|
-
| **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
10
|
+
| **usage_size_bytes** | **Integer** | The total number of bytes for all voicemail message audio recordings | [optional] |
|
|
11
|
+
| **total_count** | **Integer** | The total number of voicemail messages | [optional] |
|
|
12
|
+
| **unread_count** | **Integer** | The total number of voicemail messages marked as unread | [optional] |
|
|
13
|
+
| **deleted_count** | **Integer** | The total number of voicemail messages marked as deleted | [optional] |
|
|
14
|
+
| **created_date** | **DateTime** | The date of the oldest voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **modified_date** | **DateTime** | The date of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
16
|
{: class="table table-striped"}
|
|
17
17
|
|
|
18
18
|
|
|
@@ -8,15 +8,19 @@ title: VoicemailMessage
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
-
| **conversation** | [**Conversation**](Conversation.html) |
|
|
12
|
-
| **read** | **BOOLEAN** |
|
|
13
|
-
| **audio_recording_duration_seconds** | **Integer** |
|
|
14
|
-
| **audio_recording_size_bytes** | **Integer** |
|
|
15
|
-
| **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
17
|
-
| **caller_address** | **String** |
|
|
18
|
-
| **caller_name** | **String** |
|
|
19
|
-
| **caller_user** | [**User**](User.html) |
|
|
11
|
+
| **conversation** | [**Conversation**](Conversation.html) | The conversation that the voicemail message is associated with | [optional] |
|
|
12
|
+
| **read** | **BOOLEAN** | Whether the voicemail message is marked as read | [optional] [default to false]|
|
|
13
|
+
| **audio_recording_duration_seconds** | **Integer** | The voicemail message's audio recording duration in seconds | [optional] |
|
|
14
|
+
| **audio_recording_size_bytes** | **Integer** | The voicemail message's audio recording size in bytes | [optional] |
|
|
15
|
+
| **created_date** | **DateTime** | The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_date** | **DateTime** | The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
17
|
+
| **caller_address** | **String** | The caller address | [optional] |
|
|
18
|
+
| **caller_name** | **String** | Optionally the name of the caller that left the voicemail message if the caller was a known user | [optional] |
|
|
19
|
+
| **caller_user** | [**User**](User.html) | Optionally the user that left the voicemail message if the caller was a known user | [optional] |
|
|
20
|
+
| **deleted** | **BOOLEAN** | Whether the voicemail message has been marked as deleted | [optional] [default to false]|
|
|
21
|
+
| **note** | **String** | An optional note | [optional] |
|
|
22
|
+
| **user** | [**User**](User.html) | The user that the voicemail message belongs to or null which means the voicemail message belongs to a group | [optional] |
|
|
23
|
+
| **group** | [**Group**](Group.html) | The group that the voicemail message belongs to or null which means the voicemail message belongs to a user | [optional] |
|
|
20
24
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
25
|
{: class="table table-striped"}
|
|
22
26
|
|
|
@@ -7,9 +7,16 @@ title: VoicemailMessageEntityListing
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **total** | **Integer** | | [optional] |
|
|
11
10
|
| **entities** | [**Array<VoicemailMessage>**](VoicemailMessage.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
12
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] |
|
|
13
20
|
{: class="table table-striped"}
|
|
14
21
|
|
|
15
22
|
|
|
@@ -22,6 +22,7 @@ title: VoicemailOrganizationPolicy
|
|
|
22
22
|
| **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
23
|
| **voicemail_extension** | **String** | The extension for voicemail retrieval. The default value is *86. | [optional] |
|
|
24
24
|
| **pin_required** | **BOOLEAN** | If this is true, a PIN is required when accessing a user's voicemail from a phone. | [optional] [default to false]|
|
|
25
|
+
| **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting. | [optional] [default to false]|
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
|
27
28
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: VoicemailSearchCriteria
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::VoicemailSearchCriteria
|
|
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<VoicemailSearchCriteria>**](VoicemailSearchCriteria.html) | Groups multiple conditions | [optional] |
|
|
17
|
+
| **type** | **String** | Search Type | |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: VoicemailSearchRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::VoicemailSearchRequest
|
|
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
|
+
| **query** | [**Array<VoicemailSearchCriteria>**](VoicemailSearchCriteria.html) | | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: VoicemailsSearchResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::VoicemailsSearchResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **total** | **Integer** | The total number of results found | |
|
|
11
|
+
| **page_count** | **Integer** | The total number of pages | |
|
|
12
|
+
| **page_size** | **Integer** | The current page size | |
|
|
13
|
+
| **page_number** | **Integer** | The current page number | |
|
|
14
|
+
| **previous_page** | **String** | Q64 value for the previous page of results | [optional] |
|
|
15
|
+
| **current_page** | **String** | Q64 value for the current page of results | [optional] |
|
|
16
|
+
| **next_page** | **String** | Q64 value for the next page of results | [optional] |
|
|
17
|
+
| **types** | **Array<String>** | Resource types the search was performed against | |
|
|
18
|
+
| **results** | [**Array<VoicemailMessage>**](VoicemailMessage.html) | Search results | |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -9,11 +9,13 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
9
9
|
Method | HTTP request | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
|[**get_adherence**](WorkforceManagementApi.html#get_adherence) | **GET** /api/v2/workforcemanagement/adherence | Get a list of UserScheduleAdherence records for the requested users|
|
|
12
|
+
|[**get_decisions_downloads_download_id**](WorkforceManagementApi.html#get_decisions_downloads_download_id) | **GET** /api/v2/workforcemanagement/decisions/downloads/{downloadId} | Get decisions download link|
|
|
12
13
|
|[**get_managementunits_mu_id_users_user_id_timeoffrequests**](WorkforceManagementApi.html#get_managementunits_mu_id_users_user_id_timeoffrequests) | **GET** /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests | Get a list of time off requests for any user|
|
|
13
14
|
|[**get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id**](WorkforceManagementApi.html#get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id) | **GET** /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId} | Get a time off request by id|
|
|
14
15
|
|[**get_timeoffrequests**](WorkforceManagementApi.html#get_timeoffrequests) | **GET** /api/v2/workforcemanagement/timeoffrequests | Get a list of time off requests for the current user|
|
|
15
16
|
|[**get_timeoffrequests_timeoffrequest_id**](WorkforceManagementApi.html#get_timeoffrequests_timeoffrequest_id) | **GET** /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId} | Get a time off request for the current user by id|
|
|
16
17
|
|[**patch_timeoffrequests_timeoffrequest_id**](WorkforceManagementApi.html#patch_timeoffrequests_timeoffrequest_id) | **PATCH** /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId} | Mark a time off request for the current user as read or unread|
|
|
18
|
+
|[**post_decisions_downloads_search**](WorkforceManagementApi.html#post_decisions_downloads_search) | **POST** /api/v2/workforcemanagement/decisions/downloads/search | Download decisions files metadata|
|
|
17
19
|
|[**post_longtermforecasts**](WorkforceManagementApi.html#post_longtermforecasts) | **POST** /api/v2/workforcemanagement/longtermforecasts | Create a forecast|
|
|
18
20
|
{: class="table table-striped"}
|
|
19
21
|
|
|
@@ -73,6 +75,66 @@ Name | Type | Description | Notes
|
|
|
73
75
|
|
|
74
76
|
|
|
75
77
|
|
|
78
|
+
<a name="get_decisions_downloads_download_id"></a>
|
|
79
|
+
|
|
80
|
+
## -[**DecisionsDownloadLink**](DecisionsDownloadLink.html) get_decisions_downloads_download_id(download_id, opts)
|
|
81
|
+
|
|
82
|
+
Get decisions download link
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
~~~ruby
|
|
88
|
+
# load the gem
|
|
89
|
+
require 'purecloud'
|
|
90
|
+
# setup authorization
|
|
91
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
92
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
93
|
+
environment = "mypurecloud.com"
|
|
94
|
+
|
|
95
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
96
|
+
|
|
97
|
+
PureCloud.configure do |config|
|
|
98
|
+
config.access_token = @authToken
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
102
|
+
|
|
103
|
+
download_id = "download_id_example" # String | The decisions file download id
|
|
104
|
+
|
|
105
|
+
opts = {
|
|
106
|
+
downloadfilename: "downloadfilename" # String | The file name used to get the download url
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
begin
|
|
110
|
+
#Get decisions download link
|
|
111
|
+
result = api_instance.get_decisions_downloads_download_id(download_id, opts)
|
|
112
|
+
p result
|
|
113
|
+
rescue PureCloud::ApiError => e
|
|
114
|
+
puts "Exception when calling WorkforceManagementApi->get_decisions_downloads_download_id: #{e}"
|
|
115
|
+
end
|
|
116
|
+
~~~
|
|
117
|
+
|
|
118
|
+
### Parameters
|
|
119
|
+
|
|
120
|
+
Name | Type | Description | Notes
|
|
121
|
+
------------- | ------------- | ------------- | -------------
|
|
122
|
+
**download_id** | **String**| The decisions file download id |
|
|
123
|
+
**downloadfilename** | **String**| The file name used to get the download url | [optional] [default to downloadfilename]
|
|
124
|
+
{: class="table table-striped"}
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
### Return type
|
|
128
|
+
|
|
129
|
+
[**DecisionsDownloadLink**](DecisionsDownloadLink.html)
|
|
130
|
+
|
|
131
|
+
### HTTP request headers
|
|
132
|
+
|
|
133
|
+
- **Content-Type**: application/json
|
|
134
|
+
- **Accept**: application/json
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
76
138
|
<a name="get_managementunits_mu_id_users_user_id_timeoffrequests"></a>
|
|
77
139
|
|
|
78
140
|
## -[**TimeOffRequestList**](TimeOffRequestList.html) get_managementunits_mu_id_users_user_id_timeoffrequests(mu_id, user_id, opts)
|
|
@@ -370,6 +432,62 @@ nil (empty response body)
|
|
|
370
432
|
|
|
371
433
|
|
|
372
434
|
|
|
435
|
+
<a name="post_decisions_downloads_search"></a>
|
|
436
|
+
|
|
437
|
+
## -[**DecisionsFileMetadataEntityListing**](DecisionsFileMetadataEntityListing.html) post_decisions_downloads_search(body)
|
|
438
|
+
|
|
439
|
+
Download decisions files metadata
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
### Example
|
|
444
|
+
~~~ruby
|
|
445
|
+
# load the gem
|
|
446
|
+
require 'purecloud'
|
|
447
|
+
# setup authorization
|
|
448
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
449
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
450
|
+
environment = "mypurecloud.com"
|
|
451
|
+
|
|
452
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
453
|
+
|
|
454
|
+
PureCloud.configure do |config|
|
|
455
|
+
config.access_token = @authToken
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
459
|
+
|
|
460
|
+
body = PureCloud::ForecastSearchRequest.new # ForecastSearchRequest |
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
begin
|
|
464
|
+
#Download decisions files metadata
|
|
465
|
+
result = api_instance.post_decisions_downloads_search(body)
|
|
466
|
+
p result
|
|
467
|
+
rescue PureCloud::ApiError => e
|
|
468
|
+
puts "Exception when calling WorkforceManagementApi->post_decisions_downloads_search: #{e}"
|
|
469
|
+
end
|
|
470
|
+
~~~
|
|
471
|
+
|
|
472
|
+
### Parameters
|
|
473
|
+
|
|
474
|
+
Name | Type | Description | Notes
|
|
475
|
+
------------- | ------------- | ------------- | -------------
|
|
476
|
+
**body** | [**ForecastSearchRequest**](ForecastSearchRequest.html)| |
|
|
477
|
+
{: class="table table-striped"}
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
### Return type
|
|
481
|
+
|
|
482
|
+
[**DecisionsFileMetadataEntityListing**](DecisionsFileMetadataEntityListing.html)
|
|
483
|
+
|
|
484
|
+
### HTTP request headers
|
|
485
|
+
|
|
486
|
+
- **Content-Type**: application/json
|
|
487
|
+
- **Accept**: application/json
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
373
491
|
<a name="post_longtermforecasts"></a>
|
|
374
492
|
|
|
375
493
|
## -[**ForecastCreationCompletion**](ForecastCreationCompletion.html) post_longtermforecasts(body)
|
|
@@ -11,8 +11,8 @@ title: WorkspaceEntityListing
|
|
|
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: WorkspaceMemberEntityListing
|
|
|
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: WrapupCodeEntityListing
|
|
|
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] |
|
data/doc_out/index.html.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-12-
|
|
12
|
+
- Package version: 0.61.1
|
|
13
|
+
- Build date: 2016-12-20T22:02:42.508Z
|
|
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.61.1'
|
|
22
22
|
|
|
23
23
|
### Install from Git
|
|
24
24
|
|
data/lib/purecloud.rb
CHANGED
|
@@ -211,6 +211,7 @@ require 'purecloud/models/conversation_notification_video'
|
|
|
211
211
|
require 'purecloud/models/conversation_notification_videos'
|
|
212
212
|
require 'purecloud/models/conversation_notification_wrapup'
|
|
213
213
|
require 'purecloud/models/conversation_query'
|
|
214
|
+
require 'purecloud/models/copy_voicemail_message'
|
|
214
215
|
require 'purecloud/models/cover_sheet'
|
|
215
216
|
require 'purecloud/models/create_call_request'
|
|
216
217
|
require 'purecloud/models/create_call_response'
|
|
@@ -226,6 +227,9 @@ require 'purecloud/models/did'
|
|
|
226
227
|
require 'purecloud/models/did_entity_listing'
|
|
227
228
|
require 'purecloud/models/did_pool'
|
|
228
229
|
require 'purecloud/models/did_pool_entity_listing'
|
|
230
|
+
require 'purecloud/models/decisions_download_link'
|
|
231
|
+
require 'purecloud/models/decisions_download_metadata'
|
|
232
|
+
require 'purecloud/models/decisions_file_metadata_entity_listing'
|
|
229
233
|
require 'purecloud/models/default_greeting_list'
|
|
230
234
|
require 'purecloud/models/delete_retention'
|
|
231
235
|
require 'purecloud/models/destination'
|
|
@@ -363,10 +367,13 @@ require 'purecloud/models/field_config'
|
|
|
363
367
|
require 'purecloud/models/field_list'
|
|
364
368
|
require 'purecloud/models/forecast_creation'
|
|
365
369
|
require 'purecloud/models/forecast_creation_completion'
|
|
370
|
+
require 'purecloud/models/forecast_search_criteria'
|
|
371
|
+
require 'purecloud/models/forecast_search_request'
|
|
366
372
|
require 'purecloud/models/geolocation'
|
|
367
373
|
require 'purecloud/models/geolocation_settings'
|
|
368
374
|
require 'purecloud/models/greeting'
|
|
369
375
|
require 'purecloud/models/greeting_audio_file'
|
|
376
|
+
require 'purecloud/models/greeting_listing'
|
|
370
377
|
require 'purecloud/models/greeting_media_info'
|
|
371
378
|
require 'purecloud/models/greeting_owner'
|
|
372
379
|
require 'purecloud/models/group'
|
|
@@ -688,13 +695,17 @@ require 'purecloud/models/video_conversation_notification_uri_reference'
|
|
|
688
695
|
require 'purecloud/models/video_conversation_notification_video_media_participant'
|
|
689
696
|
require 'purecloud/models/visibility_condition'
|
|
690
697
|
require 'purecloud/models/vm_pairing_info'
|
|
698
|
+
require 'purecloud/models/voicemail_group_policy'
|
|
691
699
|
require 'purecloud/models/voicemail_mailbox_info'
|
|
692
700
|
require 'purecloud/models/voicemail_media_info'
|
|
693
701
|
require 'purecloud/models/voicemail_message'
|
|
694
702
|
require 'purecloud/models/voicemail_message_entity_listing'
|
|
695
703
|
require 'purecloud/models/voicemail_message_notification'
|
|
696
704
|
require 'purecloud/models/voicemail_organization_policy'
|
|
705
|
+
require 'purecloud/models/voicemail_search_criteria'
|
|
706
|
+
require 'purecloud/models/voicemail_search_request'
|
|
697
707
|
require 'purecloud/models/voicemail_user_policy'
|
|
708
|
+
require 'purecloud/models/voicemails_search_response'
|
|
698
709
|
require 'purecloud/models/workspace'
|
|
699
710
|
require 'purecloud/models/workspace_create'
|
|
700
711
|
require 'purecloud/models/workspace_entity_listing'
|
|
@@ -327,6 +327,132 @@ module PureCloud
|
|
|
327
327
|
return data, status_code, headers
|
|
328
328
|
end
|
|
329
329
|
|
|
330
|
+
# Get a list of the Group's Greetings
|
|
331
|
+
#
|
|
332
|
+
# @param group_id Group ID
|
|
333
|
+
# @param [Hash] opts the optional parameters
|
|
334
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
335
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
336
|
+
# @return [GreetingListing]
|
|
337
|
+
def get_group_id_greetings(group_id, opts = {})
|
|
338
|
+
data, status_code, headers = get_group_id_greetings_with_http_info(group_id, opts)
|
|
339
|
+
return data
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
# Get a list of the Group's Greetings
|
|
343
|
+
#
|
|
344
|
+
# @param group_id Group ID
|
|
345
|
+
# @param [Hash] opts the optional parameters
|
|
346
|
+
# @option opts [Integer] :page_size Page size
|
|
347
|
+
# @option opts [Integer] :page_number Page number
|
|
348
|
+
# @return [Array<(GreetingListing, Fixnum, Hash)>] GreetingListing data, response status code and response headers
|
|
349
|
+
def get_group_id_greetings_with_http_info(group_id, opts = {})
|
|
350
|
+
if @api_client.config.debugging
|
|
351
|
+
@api_client.config.logger.debug "Calling API: GreetingsApi#get_group_id_greetings ..."
|
|
352
|
+
end
|
|
353
|
+
|
|
354
|
+
# verify the required parameter 'group_id' is set
|
|
355
|
+
fail "Missing the required parameter 'group_id' when calling get_group_id_greetings" if group_id.nil?
|
|
356
|
+
|
|
357
|
+
# resource path
|
|
358
|
+
local_var_path = "/api/v2/groups/{groupId}/greetings".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
|
359
|
+
|
|
360
|
+
# query parameters
|
|
361
|
+
query_params = {}
|
|
362
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
363
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
364
|
+
|
|
365
|
+
# header parameters
|
|
366
|
+
header_params = {}
|
|
367
|
+
|
|
368
|
+
# HTTP header 'Accept' (if needed)
|
|
369
|
+
_header_accept = ['application/json']
|
|
370
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
371
|
+
|
|
372
|
+
# HTTP header 'Content-Type'
|
|
373
|
+
_header_content_type = ['application/json']
|
|
374
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
375
|
+
|
|
376
|
+
# form parameters
|
|
377
|
+
form_params = {}
|
|
378
|
+
|
|
379
|
+
# http body (model)
|
|
380
|
+
post_body = nil
|
|
381
|
+
|
|
382
|
+
auth_names = ['PureCloud Auth']
|
|
383
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
384
|
+
:header_params => header_params,
|
|
385
|
+
:query_params => query_params,
|
|
386
|
+
:form_params => form_params,
|
|
387
|
+
:body => post_body,
|
|
388
|
+
:auth_names => auth_names,
|
|
389
|
+
:return_type => 'GreetingListing')
|
|
390
|
+
if @api_client.config.debugging
|
|
391
|
+
@api_client.config.logger.debug "API called: GreetingsApi#get_group_id_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
392
|
+
end
|
|
393
|
+
return data, status_code, headers
|
|
394
|
+
end
|
|
395
|
+
|
|
396
|
+
# Grabs the list of Default Greetings given a Group's ID
|
|
397
|
+
#
|
|
398
|
+
# @param group_id Group ID
|
|
399
|
+
# @param [Hash] opts the optional parameters
|
|
400
|
+
# @return [DefaultGreetingList]
|
|
401
|
+
def get_group_id_greetings_defaults(group_id, opts = {})
|
|
402
|
+
data, status_code, headers = get_group_id_greetings_defaults_with_http_info(group_id, opts)
|
|
403
|
+
return data
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
# Grabs the list of Default Greetings given a Group's ID
|
|
407
|
+
#
|
|
408
|
+
# @param group_id Group ID
|
|
409
|
+
# @param [Hash] opts the optional parameters
|
|
410
|
+
# @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
|
|
411
|
+
def get_group_id_greetings_defaults_with_http_info(group_id, opts = {})
|
|
412
|
+
if @api_client.config.debugging
|
|
413
|
+
@api_client.config.logger.debug "Calling API: GreetingsApi#get_group_id_greetings_defaults ..."
|
|
414
|
+
end
|
|
415
|
+
|
|
416
|
+
# verify the required parameter 'group_id' is set
|
|
417
|
+
fail "Missing the required parameter 'group_id' when calling get_group_id_greetings_defaults" if group_id.nil?
|
|
418
|
+
|
|
419
|
+
# resource path
|
|
420
|
+
local_var_path = "/api/v2/groups/{groupId}/greetings/defaults".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
|
421
|
+
|
|
422
|
+
# query parameters
|
|
423
|
+
query_params = {}
|
|
424
|
+
|
|
425
|
+
# header parameters
|
|
426
|
+
header_params = {}
|
|
427
|
+
|
|
428
|
+
# HTTP header 'Accept' (if needed)
|
|
429
|
+
_header_accept = ['application/json']
|
|
430
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
431
|
+
|
|
432
|
+
# HTTP header 'Content-Type'
|
|
433
|
+
_header_content_type = ['application/json']
|
|
434
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
435
|
+
|
|
436
|
+
# form parameters
|
|
437
|
+
form_params = {}
|
|
438
|
+
|
|
439
|
+
# http body (model)
|
|
440
|
+
post_body = nil
|
|
441
|
+
|
|
442
|
+
auth_names = ['PureCloud Auth']
|
|
443
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
444
|
+
:header_params => header_params,
|
|
445
|
+
:query_params => query_params,
|
|
446
|
+
:form_params => form_params,
|
|
447
|
+
:body => post_body,
|
|
448
|
+
:auth_names => auth_names,
|
|
449
|
+
:return_type => 'DefaultGreetingList')
|
|
450
|
+
if @api_client.config.debugging
|
|
451
|
+
@api_client.config.logger.debug "API called: GreetingsApi#get_group_id_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
452
|
+
end
|
|
453
|
+
return data, status_code, headers
|
|
454
|
+
end
|
|
455
|
+
|
|
330
456
|
# Get a list of the User's Greetings
|
|
331
457
|
#
|
|
332
458
|
# @param user_id User ID
|
|
@@ -513,6 +639,71 @@ module PureCloud
|
|
|
513
639
|
return data, status_code, headers
|
|
514
640
|
end
|
|
515
641
|
|
|
642
|
+
# Creates a Greeting for a Group
|
|
643
|
+
#
|
|
644
|
+
# @param group_id Group ID
|
|
645
|
+
# @param body The Greeting to create
|
|
646
|
+
# @param [Hash] opts the optional parameters
|
|
647
|
+
# @return [Greeting]
|
|
648
|
+
def post_group_id_greetings(group_id, body, opts = {})
|
|
649
|
+
data, status_code, headers = post_group_id_greetings_with_http_info(group_id, body, opts)
|
|
650
|
+
return data
|
|
651
|
+
end
|
|
652
|
+
|
|
653
|
+
# Creates a Greeting for a Group
|
|
654
|
+
#
|
|
655
|
+
# @param group_id Group ID
|
|
656
|
+
# @param body The Greeting to create
|
|
657
|
+
# @param [Hash] opts the optional parameters
|
|
658
|
+
# @return [Array<(Greeting, Fixnum, Hash)>] Greeting data, response status code and response headers
|
|
659
|
+
def post_group_id_greetings_with_http_info(group_id, body, opts = {})
|
|
660
|
+
if @api_client.config.debugging
|
|
661
|
+
@api_client.config.logger.debug "Calling API: GreetingsApi#post_group_id_greetings ..."
|
|
662
|
+
end
|
|
663
|
+
|
|
664
|
+
# verify the required parameter 'group_id' is set
|
|
665
|
+
fail "Missing the required parameter 'group_id' when calling post_group_id_greetings" if group_id.nil?
|
|
666
|
+
|
|
667
|
+
# verify the required parameter 'body' is set
|
|
668
|
+
fail "Missing the required parameter 'body' when calling post_group_id_greetings" if body.nil?
|
|
669
|
+
|
|
670
|
+
# resource path
|
|
671
|
+
local_var_path = "/api/v2/groups/{groupId}/greetings".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
|
672
|
+
|
|
673
|
+
# query parameters
|
|
674
|
+
query_params = {}
|
|
675
|
+
|
|
676
|
+
# header parameters
|
|
677
|
+
header_params = {}
|
|
678
|
+
|
|
679
|
+
# HTTP header 'Accept' (if needed)
|
|
680
|
+
_header_accept = ['application/json']
|
|
681
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
682
|
+
|
|
683
|
+
# HTTP header 'Content-Type'
|
|
684
|
+
_header_content_type = ['application/json']
|
|
685
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
686
|
+
|
|
687
|
+
# form parameters
|
|
688
|
+
form_params = {}
|
|
689
|
+
|
|
690
|
+
# http body (model)
|
|
691
|
+
post_body = @api_client.object_to_http_body(body)
|
|
692
|
+
|
|
693
|
+
auth_names = ['PureCloud Auth']
|
|
694
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
695
|
+
:header_params => header_params,
|
|
696
|
+
:query_params => query_params,
|
|
697
|
+
:form_params => form_params,
|
|
698
|
+
:body => post_body,
|
|
699
|
+
:auth_names => auth_names,
|
|
700
|
+
:return_type => 'Greeting')
|
|
701
|
+
if @api_client.config.debugging
|
|
702
|
+
@api_client.config.logger.debug "API called: GreetingsApi#post_group_id_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
703
|
+
end
|
|
704
|
+
return data, status_code, headers
|
|
705
|
+
end
|
|
706
|
+
|
|
516
707
|
# Creates a Greeting for a User
|
|
517
708
|
#
|
|
518
709
|
# @param user_id User ID
|
|
@@ -703,6 +894,71 @@ module PureCloud
|
|
|
703
894
|
return data, status_code, headers
|
|
704
895
|
end
|
|
705
896
|
|
|
897
|
+
# Updates the DefaultGreetingList of the specified Group
|
|
898
|
+
#
|
|
899
|
+
# @param group_id Group ID
|
|
900
|
+
# @param body The updated defaultGreetingList
|
|
901
|
+
# @param [Hash] opts the optional parameters
|
|
902
|
+
# @return [DefaultGreetingList]
|
|
903
|
+
def put_group_id_greetings_defaults(group_id, body, opts = {})
|
|
904
|
+
data, status_code, headers = put_group_id_greetings_defaults_with_http_info(group_id, body, opts)
|
|
905
|
+
return data
|
|
906
|
+
end
|
|
907
|
+
|
|
908
|
+
# Updates the DefaultGreetingList of the specified Group
|
|
909
|
+
#
|
|
910
|
+
# @param group_id Group ID
|
|
911
|
+
# @param body The updated defaultGreetingList
|
|
912
|
+
# @param [Hash] opts the optional parameters
|
|
913
|
+
# @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
|
|
914
|
+
def put_group_id_greetings_defaults_with_http_info(group_id, body, opts = {})
|
|
915
|
+
if @api_client.config.debugging
|
|
916
|
+
@api_client.config.logger.debug "Calling API: GreetingsApi#put_group_id_greetings_defaults ..."
|
|
917
|
+
end
|
|
918
|
+
|
|
919
|
+
# verify the required parameter 'group_id' is set
|
|
920
|
+
fail "Missing the required parameter 'group_id' when calling put_group_id_greetings_defaults" if group_id.nil?
|
|
921
|
+
|
|
922
|
+
# verify the required parameter 'body' is set
|
|
923
|
+
fail "Missing the required parameter 'body' when calling put_group_id_greetings_defaults" if body.nil?
|
|
924
|
+
|
|
925
|
+
# resource path
|
|
926
|
+
local_var_path = "/api/v2/groups/{groupId}/greetings/defaults".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
|
927
|
+
|
|
928
|
+
# query parameters
|
|
929
|
+
query_params = {}
|
|
930
|
+
|
|
931
|
+
# header parameters
|
|
932
|
+
header_params = {}
|
|
933
|
+
|
|
934
|
+
# HTTP header 'Accept' (if needed)
|
|
935
|
+
_header_accept = ['application/json']
|
|
936
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
937
|
+
|
|
938
|
+
# HTTP header 'Content-Type'
|
|
939
|
+
_header_content_type = ['application/json']
|
|
940
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
941
|
+
|
|
942
|
+
# form parameters
|
|
943
|
+
form_params = {}
|
|
944
|
+
|
|
945
|
+
# http body (model)
|
|
946
|
+
post_body = @api_client.object_to_http_body(body)
|
|
947
|
+
|
|
948
|
+
auth_names = ['PureCloud Auth']
|
|
949
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
950
|
+
:header_params => header_params,
|
|
951
|
+
:query_params => query_params,
|
|
952
|
+
:form_params => form_params,
|
|
953
|
+
:body => post_body,
|
|
954
|
+
:auth_names => auth_names,
|
|
955
|
+
:return_type => 'DefaultGreetingList')
|
|
956
|
+
if @api_client.config.debugging
|
|
957
|
+
@api_client.config.logger.debug "API called: GreetingsApi#put_group_id_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
958
|
+
end
|
|
959
|
+
return data, status_code, headers
|
|
960
|
+
end
|
|
961
|
+
|
|
706
962
|
# Updates the DefaultGreetingList of the specified User
|
|
707
963
|
#
|
|
708
964
|
# @param user_id User ID
|