purecloud 0.56.1 → 0.57.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 +2 -2
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/Cobrowsesession.html.md +1 -0
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKey.html.md +4 -4
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/ForecastCreation.html.md +1 -0
- data/doc_out/ForecastCreationCompletion.html.md +2 -1
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfiguration.html.md +18 -0
- data/doc_out/{ForecastMetadataEntityListing.html.md → LocalEncryptionConfigurationListing.html.md} +5 -5
- data/doc_out/LocalEncryptionKeyRequest.html.md +15 -0
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +501 -0
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/Screenshare.html.md +1 -0
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/User.html.md +1 -0
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserMe.html.md +2 -0
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/WorkforceManagementApi.html.md +0 -406
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +3 -11
- data/lib/purecloud/api/recording_api.rb +531 -0
- data/lib/purecloud/api/workforce_management_api.rb +0 -433
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowsesession.rb +17 -4
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/dialer_action.rb +1 -1
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key.rb +4 -1
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/forecast_creation.rb +15 -4
- data/lib/purecloud/models/forecast_creation_completion.rb +18 -7
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/{forecast.rb → local_encryption_configuration.rb} +51 -32
- data/lib/purecloud/models/{forecast_metadata_entity_listing.rb → local_encryption_configuration_listing.rb} +19 -19
- data/lib/purecloud/models/{forecast_filter_attributes.rb → local_encryption_key_request.rb} +23 -26
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/screenshare.rb +17 -4
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user.rb +11 -1
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_me.rb +24 -1
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/users_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +8 -24
- data/doc_out/ConfigurationApi.html.md +0 -231
- data/doc_out/Forecast.html.md +0 -16
- data/doc_out/ForecastDimensions.html.md +0 -15
- data/doc_out/ForecastEntry.html.md +0 -15
- data/doc_out/ForecastFilterAttributes.html.md +0 -15
- data/doc_out/ForecastMetadata.html.md +0 -22
- data/doc_out/ForecastModification.html.md +0 -27
- data/doc_out/ForecastModificationCreation.html.md +0 -25
- data/doc_out/ForecastSearchCriteria.html.md +0 -20
- data/doc_out/ForecastSearchRequest.html.md +0 -20
- data/lib/purecloud/api/configuration_api.rb +0 -258
- data/lib/purecloud/models/forecast_dimensions.rb +0 -197
- data/lib/purecloud/models/forecast_entry.rb +0 -199
- data/lib/purecloud/models/forecast_metadata.rb +0 -284
- data/lib/purecloud/models/forecast_modification.rb +0 -339
- data/lib/purecloud/models/forecast_modification_creation.rb +0 -317
- data/lib/purecloud/models/forecast_search_criteria.rb +0 -267
- data/lib/purecloud/models/forecast_search_request.rb +0 -259
@@ -11,10 +11,10 @@ title: ReportMetaDataEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: ReportRunEntryEntityDomainListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: ReportScheduleEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: ResponseEntityList
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: ResponseEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: ResponseSetEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: RuleSetEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: SchemaCategoryEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: SchemaReferenceEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: ScreenRecordingSessionListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/doc_out/Screenshare.html.md
CHANGED
@@ -16,6 +16,7 @@ title: Screenshare
|
|
16
16
|
| **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
17
17
|
| **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
18
18
|
| **provider** | **String** | The source provider for the screen share. | [optional] |
|
19
|
+
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's call, divided into activity segments. | [optional] |
|
19
20
|
{: class="table table-striped"}
|
20
21
|
|
21
22
|
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/doc_out/User.html.md
CHANGED
@@ -17,6 +17,7 @@ title: User
|
|
17
17
|
| **state** | **String** | The current state for this user. | [optional] |
|
18
18
|
| **title** | **String** | | [optional] |
|
19
19
|
| **username** | **String** | | [optional] |
|
20
|
+
| **manager** | [**User**](User.html) | | [optional] |
|
20
21
|
| **images** | [**Array<UserImage>**](UserImage.html) | | [optional] |
|
21
22
|
| **version** | **Integer** | Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. | |
|
22
23
|
| **routing_status** | [**RoutingStatus**](RoutingStatus.html) | ACD routing status | [optional] |
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/doc_out/UserMe.html.md
CHANGED
@@ -17,6 +17,7 @@ title: UserMe
|
|
17
17
|
| **state** | **String** | The current state for this user. | [optional] |
|
18
18
|
| **title** | **String** | | [optional] |
|
19
19
|
| **username** | **String** | | [optional] |
|
20
|
+
| **manager** | [**User**](User.html) | | [optional] |
|
20
21
|
| **images** | [**Array<UserImage>**](UserImage.html) | | [optional] |
|
21
22
|
| **version** | **Integer** | Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. | |
|
22
23
|
| **routing_status** | [**RoutingStatus**](RoutingStatus.html) | ACD routing status | [optional] |
|
@@ -37,6 +38,7 @@ title: UserMe
|
|
37
38
|
| **superiors** | [**Array<User>**](User.html) | The first 50 superiors of this user. | [optional] |
|
38
39
|
| **direct_reports** | [**Array<User>**](User.html) | The first 50 direct reports to this user. | [optional] |
|
39
40
|
| **adjacents** | [**Adjacents**](Adjacents.html) | The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands. | [optional] |
|
41
|
+
| **routing_skills** | [**Array<RoutingSkill>**](RoutingSkill.html) | The first 50 routing skills for user's organizations | [optional] |
|
40
42
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
41
43
|
{: class="table table-striped"}
|
42
44
|
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ 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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -11,10 +11,10 @@ title: UsersEntityListing
|
|
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
|
-
| **
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -8,130 +8,10 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | HTTP request | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
-
|[**delete_longtermforecasts_forecast_id**](WorkforceManagementApi.html#delete_longtermforecasts_forecast_id) | **DELETE** /api/v2/workforcemanagement/longtermforecasts/{forecastId} | Delete a forecast|
|
12
|
-
|[**delete_longtermforecasts_forecast_id_modifications_forecastmodification_id**](WorkforceManagementApi.html#delete_longtermforecasts_forecast_id_modifications_forecastmodification_id) | **DELETE** /api/v2/workforcemanagement/longtermforecasts/{forecastId}/modifications/{forecastModificationId} | Delete a forecast modification|
|
13
11
|
|[**get_adherence**](WorkforceManagementApi.html#get_adherence) | **GET** /api/v2/workforcemanagement/adherence | Get a list of UserScheduleAdherence records for the requested users|
|
14
|
-
|[**get_longtermforecasts_forecast_id**](WorkforceManagementApi.html#get_longtermforecasts_forecast_id) | **GET** /api/v2/workforcemanagement/longtermforecasts/{forecastId} | Get forecast|
|
15
|
-
|[**get_longtermforecasts_forecast_id_modifications**](WorkforceManagementApi.html#get_longtermforecasts_forecast_id_modifications) | **GET** /api/v2/workforcemanagement/longtermforecasts/{forecastId}/modifications | Get forecast Modifications|
|
16
12
|
|[**post_longtermforecasts**](WorkforceManagementApi.html#post_longtermforecasts) | **POST** /api/v2/workforcemanagement/longtermforecasts | Create a forecast|
|
17
|
-
|[**post_longtermforecasts_forecast_id_modifications**](WorkforceManagementApi.html#post_longtermforecasts_forecast_id_modifications) | **POST** /api/v2/workforcemanagement/longtermforecasts/{forecastId}/modifications | Create a forecast modification|
|
18
|
-
|[**post_longtermforecasts_search**](WorkforceManagementApi.html#post_longtermforecasts_search) | **POST** /api/v2/workforcemanagement/longtermforecasts/search | Search forecasts|
|
19
|
-
|[**put_longtermforecasts_forecast_id_modifications**](WorkforceManagementApi.html#put_longtermforecasts_forecast_id_modifications) | **PUT** /api/v2/workforcemanagement/longtermforecasts/{forecastId}/modifications | Update a forecast modification|
|
20
13
|
{: class="table table-striped"}
|
21
14
|
|
22
|
-
<a name="delete_longtermforecasts_forecast_id"></a>
|
23
|
-
|
24
|
-
## - delete_longtermforecasts_forecast_id(forecast_id)
|
25
|
-
|
26
|
-
Delete a forecast
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
### Example
|
31
|
-
~~~ruby
|
32
|
-
# load the gem
|
33
|
-
require 'purecloud'
|
34
|
-
# setup authorization
|
35
|
-
@secret = ENV['PURECLOUD_SECRET']
|
36
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
37
|
-
environment = "mypurecloud.com"
|
38
|
-
|
39
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
40
|
-
|
41
|
-
PureCloud.configure do |config|
|
42
|
-
config.access_token = @authToken
|
43
|
-
end
|
44
|
-
|
45
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
46
|
-
|
47
|
-
forecast_id = "forecast_id_example" # String | The forecast id
|
48
|
-
|
49
|
-
|
50
|
-
begin
|
51
|
-
#Delete a forecast
|
52
|
-
api_instance.delete_longtermforecasts_forecast_id(forecast_id)
|
53
|
-
rescue PureCloud::ApiError => e
|
54
|
-
puts "Exception when calling WorkforceManagementApi->delete_longtermforecasts_forecast_id: #{e}"
|
55
|
-
end
|
56
|
-
~~~
|
57
|
-
|
58
|
-
### Parameters
|
59
|
-
|
60
|
-
Name | Type | Description | Notes
|
61
|
-
------------- | ------------- | ------------- | -------------
|
62
|
-
**forecast_id** | **String**| The forecast id |
|
63
|
-
{: class="table table-striped"}
|
64
|
-
|
65
|
-
|
66
|
-
### Return type
|
67
|
-
|
68
|
-
nil (empty response body)
|
69
|
-
|
70
|
-
### HTTP request headers
|
71
|
-
|
72
|
-
- **Content-Type**: application/json
|
73
|
-
- **Accept**: application/json
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
<a name="delete_longtermforecasts_forecast_id_modifications_forecastmodification_id"></a>
|
78
|
-
|
79
|
-
## - delete_longtermforecasts_forecast_id_modifications_forecastmodification_id(forecast_id, forecast_modification_id)
|
80
|
-
|
81
|
-
Delete a forecast modification
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
### Example
|
86
|
-
~~~ruby
|
87
|
-
# load the gem
|
88
|
-
require 'purecloud'
|
89
|
-
# setup authorization
|
90
|
-
@secret = ENV['PURECLOUD_SECRET']
|
91
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
92
|
-
environment = "mypurecloud.com"
|
93
|
-
|
94
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
95
|
-
|
96
|
-
PureCloud.configure do |config|
|
97
|
-
config.access_token = @authToken
|
98
|
-
end
|
99
|
-
|
100
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
101
|
-
|
102
|
-
forecast_id = "forecast_id_example" # String | The forecast id
|
103
|
-
|
104
|
-
forecast_modification_id = "forecast_modification_id_example" # String | The forecast Modification id
|
105
|
-
|
106
|
-
|
107
|
-
begin
|
108
|
-
#Delete a forecast modification
|
109
|
-
api_instance.delete_longtermforecasts_forecast_id_modifications_forecastmodification_id(forecast_id, forecast_modification_id)
|
110
|
-
rescue PureCloud::ApiError => e
|
111
|
-
puts "Exception when calling WorkforceManagementApi->delete_longtermforecasts_forecast_id_modifications_forecastmodification_id: #{e}"
|
112
|
-
end
|
113
|
-
~~~
|
114
|
-
|
115
|
-
### Parameters
|
116
|
-
|
117
|
-
Name | Type | Description | Notes
|
118
|
-
------------- | ------------- | ------------- | -------------
|
119
|
-
**forecast_id** | **String**| The forecast id |
|
120
|
-
**forecast_modification_id** | **String**| The forecast Modification id |
|
121
|
-
{: class="table table-striped"}
|
122
|
-
|
123
|
-
|
124
|
-
### Return type
|
125
|
-
|
126
|
-
nil (empty response body)
|
127
|
-
|
128
|
-
### HTTP request headers
|
129
|
-
|
130
|
-
- **Content-Type**: application/json
|
131
|
-
- **Accept**: application/json
|
132
|
-
|
133
|
-
|
134
|
-
|
135
15
|
<a name="get_adherence"></a>
|
136
16
|
|
137
17
|
## -[**UserScheduleAdherence**](UserScheduleAdherence.html) get_adherence(user_id)
|
@@ -188,118 +68,6 @@ Name | Type | Description | Notes
|
|
188
68
|
|
189
69
|
|
190
70
|
|
191
|
-
<a name="get_longtermforecasts_forecast_id"></a>
|
192
|
-
|
193
|
-
## -[**Forecast**](Forecast.html) get_longtermforecasts_forecast_id(forecast_id)
|
194
|
-
|
195
|
-
Get forecast
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
### Example
|
200
|
-
~~~ruby
|
201
|
-
# load the gem
|
202
|
-
require 'purecloud'
|
203
|
-
# setup authorization
|
204
|
-
@secret = ENV['PURECLOUD_SECRET']
|
205
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
206
|
-
environment = "mypurecloud.com"
|
207
|
-
|
208
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
209
|
-
|
210
|
-
PureCloud.configure do |config|
|
211
|
-
config.access_token = @authToken
|
212
|
-
end
|
213
|
-
|
214
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
215
|
-
|
216
|
-
forecast_id = "forecast_id_example" # String | The forecast id
|
217
|
-
|
218
|
-
|
219
|
-
begin
|
220
|
-
#Get forecast
|
221
|
-
result = api_instance.get_longtermforecasts_forecast_id(forecast_id)
|
222
|
-
p result
|
223
|
-
rescue PureCloud::ApiError => e
|
224
|
-
puts "Exception when calling WorkforceManagementApi->get_longtermforecasts_forecast_id: #{e}"
|
225
|
-
end
|
226
|
-
~~~
|
227
|
-
|
228
|
-
### Parameters
|
229
|
-
|
230
|
-
Name | Type | Description | Notes
|
231
|
-
------------- | ------------- | ------------- | -------------
|
232
|
-
**forecast_id** | **String**| The forecast id |
|
233
|
-
{: class="table table-striped"}
|
234
|
-
|
235
|
-
|
236
|
-
### Return type
|
237
|
-
|
238
|
-
[**Forecast**](Forecast.html)
|
239
|
-
|
240
|
-
### HTTP request headers
|
241
|
-
|
242
|
-
- **Content-Type**: application/json
|
243
|
-
- **Accept**: application/json
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
<a name="get_longtermforecasts_forecast_id_modifications"></a>
|
248
|
-
|
249
|
-
## -[**Array<ForecastModification>**](ForecastModification.html) get_longtermforecasts_forecast_id_modifications(forecast_id)
|
250
|
-
|
251
|
-
Get forecast Modifications
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
### Example
|
256
|
-
~~~ruby
|
257
|
-
# load the gem
|
258
|
-
require 'purecloud'
|
259
|
-
# setup authorization
|
260
|
-
@secret = ENV['PURECLOUD_SECRET']
|
261
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
262
|
-
environment = "mypurecloud.com"
|
263
|
-
|
264
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
265
|
-
|
266
|
-
PureCloud.configure do |config|
|
267
|
-
config.access_token = @authToken
|
268
|
-
end
|
269
|
-
|
270
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
271
|
-
|
272
|
-
forecast_id = "forecast_id_example" # String | The forecast id
|
273
|
-
|
274
|
-
|
275
|
-
begin
|
276
|
-
#Get forecast Modifications
|
277
|
-
result = api_instance.get_longtermforecasts_forecast_id_modifications(forecast_id)
|
278
|
-
p result
|
279
|
-
rescue PureCloud::ApiError => e
|
280
|
-
puts "Exception when calling WorkforceManagementApi->get_longtermforecasts_forecast_id_modifications: #{e}"
|
281
|
-
end
|
282
|
-
~~~
|
283
|
-
|
284
|
-
### Parameters
|
285
|
-
|
286
|
-
Name | Type | Description | Notes
|
287
|
-
------------- | ------------- | ------------- | -------------
|
288
|
-
**forecast_id** | **String**| The forecast id |
|
289
|
-
{: class="table table-striped"}
|
290
|
-
|
291
|
-
|
292
|
-
### Return type
|
293
|
-
|
294
|
-
[**Array<ForecastModification>**](ForecastModification.html)
|
295
|
-
|
296
|
-
### HTTP request headers
|
297
|
-
|
298
|
-
- **Content-Type**: application/json
|
299
|
-
- **Accept**: application/json
|
300
|
-
|
301
|
-
|
302
|
-
|
303
71
|
<a name="post_longtermforecasts"></a>
|
304
72
|
|
305
73
|
## -[**ForecastCreationCompletion**](ForecastCreationCompletion.html) post_longtermforecasts(body)
|
@@ -356,177 +124,3 @@ Name | Type | Description | Notes
|
|
356
124
|
|
357
125
|
|
358
126
|
|
359
|
-
<a name="post_longtermforecasts_forecast_id_modifications"></a>
|
360
|
-
|
361
|
-
## -[**ForecastModificationCreation**](ForecastModificationCreation.html) post_longtermforecasts_forecast_id_modifications(forecast_id, body)
|
362
|
-
|
363
|
-
Create a forecast modification
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
### Example
|
368
|
-
~~~ruby
|
369
|
-
# load the gem
|
370
|
-
require 'purecloud'
|
371
|
-
# setup authorization
|
372
|
-
@secret = ENV['PURECLOUD_SECRET']
|
373
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
374
|
-
environment = "mypurecloud.com"
|
375
|
-
|
376
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
377
|
-
|
378
|
-
PureCloud.configure do |config|
|
379
|
-
config.access_token = @authToken
|
380
|
-
end
|
381
|
-
|
382
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
383
|
-
|
384
|
-
forecast_id = "forecast_id_example" # String | The forecast id
|
385
|
-
|
386
|
-
body = PureCloud::ForecastModificationCreation.new # ForecastModificationCreation | The request body
|
387
|
-
|
388
|
-
|
389
|
-
begin
|
390
|
-
#Create a forecast modification
|
391
|
-
result = api_instance.post_longtermforecasts_forecast_id_modifications(forecast_id, body)
|
392
|
-
p result
|
393
|
-
rescue PureCloud::ApiError => e
|
394
|
-
puts "Exception when calling WorkforceManagementApi->post_longtermforecasts_forecast_id_modifications: #{e}"
|
395
|
-
end
|
396
|
-
~~~
|
397
|
-
|
398
|
-
### Parameters
|
399
|
-
|
400
|
-
Name | Type | Description | Notes
|
401
|
-
------------- | ------------- | ------------- | -------------
|
402
|
-
**forecast_id** | **String**| The forecast id |
|
403
|
-
**body** | [**ForecastModificationCreation**](ForecastModificationCreation.html)| The request body |
|
404
|
-
{: class="table table-striped"}
|
405
|
-
|
406
|
-
|
407
|
-
### Return type
|
408
|
-
|
409
|
-
[**ForecastModificationCreation**](ForecastModificationCreation.html)
|
410
|
-
|
411
|
-
### HTTP request headers
|
412
|
-
|
413
|
-
- **Content-Type**: application/json
|
414
|
-
- **Accept**: application/json
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
<a name="post_longtermforecasts_search"></a>
|
419
|
-
|
420
|
-
## -[**ForecastMetadataEntityListing**](ForecastMetadataEntityListing.html) post_longtermforecasts_search(body)
|
421
|
-
|
422
|
-
Search forecasts
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
### Example
|
427
|
-
~~~ruby
|
428
|
-
# load the gem
|
429
|
-
require 'purecloud'
|
430
|
-
# setup authorization
|
431
|
-
@secret = ENV['PURECLOUD_SECRET']
|
432
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
433
|
-
environment = "mypurecloud.com"
|
434
|
-
|
435
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
436
|
-
|
437
|
-
PureCloud.configure do |config|
|
438
|
-
config.access_token = @authToken
|
439
|
-
end
|
440
|
-
|
441
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
442
|
-
|
443
|
-
body = PureCloud::ForecastSearchRequest.new # ForecastSearchRequest |
|
444
|
-
|
445
|
-
|
446
|
-
begin
|
447
|
-
#Search forecasts
|
448
|
-
result = api_instance.post_longtermforecasts_search(body)
|
449
|
-
p result
|
450
|
-
rescue PureCloud::ApiError => e
|
451
|
-
puts "Exception when calling WorkforceManagementApi->post_longtermforecasts_search: #{e}"
|
452
|
-
end
|
453
|
-
~~~
|
454
|
-
|
455
|
-
### Parameters
|
456
|
-
|
457
|
-
Name | Type | Description | Notes
|
458
|
-
------------- | ------------- | ------------- | -------------
|
459
|
-
**body** | [**ForecastSearchRequest**](ForecastSearchRequest.html)| |
|
460
|
-
{: class="table table-striped"}
|
461
|
-
|
462
|
-
|
463
|
-
### Return type
|
464
|
-
|
465
|
-
[**ForecastMetadataEntityListing**](ForecastMetadataEntityListing.html)
|
466
|
-
|
467
|
-
### HTTP request headers
|
468
|
-
|
469
|
-
- **Content-Type**: application/json
|
470
|
-
- **Accept**: application/json
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
<a name="put_longtermforecasts_forecast_id_modifications"></a>
|
475
|
-
|
476
|
-
## -[**ForecastModification**](ForecastModification.html) put_longtermforecasts_forecast_id_modifications(forecast_id, body)
|
477
|
-
|
478
|
-
Update a forecast modification
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
### Example
|
483
|
-
~~~ruby
|
484
|
-
# load the gem
|
485
|
-
require 'purecloud'
|
486
|
-
# setup authorization
|
487
|
-
@secret = ENV['PURECLOUD_SECRET']
|
488
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
489
|
-
environment = "mypurecloud.com"
|
490
|
-
|
491
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
492
|
-
|
493
|
-
PureCloud.configure do |config|
|
494
|
-
config.access_token = @authToken
|
495
|
-
end
|
496
|
-
|
497
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
498
|
-
|
499
|
-
forecast_id = "forecast_id_example" # String | The forecast id
|
500
|
-
|
501
|
-
body = PureCloud::ForecastModification.new # ForecastModification | The request body
|
502
|
-
|
503
|
-
|
504
|
-
begin
|
505
|
-
#Update a forecast modification
|
506
|
-
result = api_instance.put_longtermforecasts_forecast_id_modifications(forecast_id, body)
|
507
|
-
p result
|
508
|
-
rescue PureCloud::ApiError => e
|
509
|
-
puts "Exception when calling WorkforceManagementApi->put_longtermforecasts_forecast_id_modifications: #{e}"
|
510
|
-
end
|
511
|
-
~~~
|
512
|
-
|
513
|
-
### Parameters
|
514
|
-
|
515
|
-
Name | Type | Description | Notes
|
516
|
-
------------- | ------------- | ------------- | -------------
|
517
|
-
**forecast_id** | **String**| The forecast id |
|
518
|
-
**body** | [**ForecastModification**](ForecastModification.html)| The request body |
|
519
|
-
{: class="table table-striped"}
|
520
|
-
|
521
|
-
|
522
|
-
### Return type
|
523
|
-
|
524
|
-
[**ForecastModification**](ForecastModification.html)
|
525
|
-
|
526
|
-
### HTTP request headers
|
527
|
-
|
528
|
-
- **Content-Type**: application/json
|
529
|
-
- **Accept**: application/json
|
530
|
-
|
531
|
-
|
532
|
-
|