purecloud 0.44.1 → 0.45.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/Account.html.md +12 -12
- data/doc_out/AddressListing.html.md +2 -2
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +15 -18
- data/doc_out/AnalyticsApi.html.md +45 -54
- data/doc_out/AnalyticsSession.html.md +6 -0
- data/doc_out/AssetEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AttributesApi.html.md +15 -18
- data/doc_out/AuthorizationApi.html.md +43 -51
- data/doc_out/AvailableAdditionalServiceListing.html.md +2 -2
- data/doc_out/AvailableTopicEntityListing.html.md +2 -2
- data/doc_out/BillingAddress.html.md +5 -5
- data/doc_out/BillingContactListing.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/CarrierEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChannelTopicEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ConfigurationApi.html.md +5 -6
- data/doc_out/ConsumedResourcesEntityListing.html.md +2 -2
- data/doc_out/ConsumingResourcesEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactListing.html.md +2 -2
- data/doc_out/ContactSales.html.md +10 -10
- data/doc_out/ContentManagementApi.html.md +50 -52
- data/doc_out/Contract.html.md +3 -3
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +140 -168
- data/doc_out/CreateCallbackCommand.html.md +2 -1
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DependencyObjectEntityListing.html.md +2 -2
- data/doc_out/DependencyTypeEntityListing.html.md +2 -2
- data/doc_out/Deployment.html.md +17 -0
- data/doc_out/DeploymentEntityListing.html.md +22 -0
- data/doc_out/DncList.html.md +4 -0
- 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/DomainBillingPeriodEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +1 -1
- 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/DomainInvoiceEntityListing.html.md +2 -2
- data/doc_out/DomainLogicalInterface.html.md +3 -3
- data/doc_out/DomainThirdPartyAccountEntityListing.html.md +2 -2
- data/doc_out/DomainThirdPartySubscriptionEntityListing.html.md +2 -2
- data/doc_out/DomainVoiceRateExtendedResponseItemEntityListing.html.md +2 -2
- data/doc_out/DomainVoiceRateInternationalResponseItemEntityListing.html.md +2 -2
- data/doc_out/DomainVoiceRateResponseItemEntityListing.html.md +2 -2
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroup.html.md +1 -1
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/Endpoint.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/ExpressionResponse.html.md +1 -1
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/ExternalContact.html.md +1 -0
- data/doc_out/ExternalOrganization.html.md +1 -0
- data/doc_out/ExternalOrganizationListing.html.md +2 -2
- data/doc_out/FaxApi.html.md +5 -6
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/Flow.html.md +5 -2
- data/doc_out/FlowConfigMetaDataEntityListing.html.md +2 -2
- data/doc_out/FlowEntityListing.html.md +2 -2
- data/doc_out/FlowVersionConfigMetaDataEntityListing.html.md +2 -2
- data/doc_out/FlowVersionEntityListing.html.md +2 -2
- data/doc_out/GeolocationApi.html.md +10 -12
- data/doc_out/Gistener.html.md +2 -2
- data/doc_out/Greeting.html.md +3 -3
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupTag.html.md +1 -1
- data/doc_out/GroupsApi.html.md +20 -22
- data/doc_out/HardwareRateListing.html.md +2 -2
- data/doc_out/IVREntityListing.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +35 -42
- data/doc_out/InboundDomain.html.md +1 -1
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/IntegrationEntityListing.html.md +2 -2
- data/doc_out/IntegrationTypeEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +1 -1
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LanguagesApi.html.md +13 -13
- 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/LinkedEntityListingFlowDetails.html.md +2 -2
- data/doc_out/LinkedEntityListingWorkItemSearchDetails.html.md +2 -2
- data/doc_out/LocationsApi.html.md +10 -10
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/NoteListing.html.md +2 -2
- data/doc_out/NotificationsApi.html.md +10 -12
- data/doc_out/OAuthApi.html.md +10 -12
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Operation.html.md +16 -0
- data/doc_out/Order.html.md +2 -2
- data/doc_out/OrganizationPresence.html.md +1 -0
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutboundApi.html.md +125 -145
- data/doc_out/OutboundRoute.html.md +1 -1
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PaymentMethod.html.md +3 -3
- data/doc_out/PaymentMethodListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/Phone.html.md +3 -3
- data/doc_out/PhoneBase.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/PresenceApi.html.md +5 -6
- data/doc_out/Prompt.html.md +1 -0
- data/doc_out/PromptAssetEntityListing.html.md +2 -2
- data/doc_out/PromptEntityListing.html.md +2 -2
- data/doc_out/Publication.html.md +1 -1
- data/doc_out/QualityApi.html.md +55 -58
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/Quote.html.md +3 -3
- data/doc_out/QuoteListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +30 -36
- data/doc_out/RelationshipListing.html.md +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportSchedule.html.md +3 -3
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResourcePermissionPolicy.html.md +1 -0
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseManagementApi.html.md +25 -30
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RoutingApi.html.md +80 -94
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/SceneEntityListing.html.md +2 -2
- data/doc_out/SceneGroupEntityListing.html.md +2 -2
- data/doc_out/ScheduleEntityListing.html.md +2 -2
- data/doc_out/ScheduleGroupEntityListing.html.md +2 -2
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/SearchApi.html.md +50 -46
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ServiceEntityListing.html.md +2 -2
- data/doc_out/Share.html.md +1 -0
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/Site.html.md +1 -1
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialAccount.html.md +2 -2
- data/doc_out/SocialConversationEntityListing.html.md +2 -2
- data/doc_out/SocializeFilterRequest.html.md +1 -1
- data/doc_out/SpreadsheetTransformEntityListing.html.md +2 -2
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/SuggestApi.html.md +20 -16
- data/doc_out/SupportCreditListing.html.md +2 -2
- data/doc_out/SystemPromptAssetEntityListing.html.md +2 -2
- data/doc_out/SystemPromptEntityListing.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +160 -192
- data/doc_out/TemplateEntityListing.html.md +2 -2
- data/doc_out/TextTableTransformEntityListing.html.md +2 -2
- data/doc_out/TimeOffRequest.html.md +30 -0
- data/doc_out/TimeOffRequestList.html.md +16 -0
- data/doc_out/TimeOffRequestPatch.html.md +13 -0
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/TwitterExpression.html.md +4 -4
- data/doc_out/TwitterId.html.md +17 -0
- data/doc_out/UserActionCategoryEntityListing.html.md +2 -2
- data/doc_out/UserActionMetadataEntityListing.html.md +1 -1
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +5 -4
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +86 -99
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/UtilitiesApi.html.md +5 -6
- data/doc_out/VideoConversationEntityListing.html.md +2 -2
- data/doc_out/VoiceRateInternationalEntityListing.html.md +2 -2
- data/doc_out/VoiceXmlOperation.html.md +1 -0
- data/doc_out/VoiceXmlOperationEntityListing.html.md +2 -2
- data/doc_out/VoicemailApi.html.md +10 -12
- data/doc_out/WaypointEntityListing.html.md +2 -2
- 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 +7 -0
- data/lib/purecloud/api/alerting_api.rb +27 -18
- data/lib/purecloud/api/analytics_api.rb +81 -54
- data/lib/purecloud/api/attributes_api.rb +27 -18
- data/lib/purecloud/api/authorization_api.rb +74 -50
- data/lib/purecloud/api/configuration_api.rb +9 -6
- data/lib/purecloud/api/content_management_api.rb +90 -60
- data/lib/purecloud/api/conversations_api.rb +252 -168
- data/lib/purecloud/api/fax_api.rb +9 -6
- data/lib/purecloud/api/geolocation_api.rb +18 -12
- data/lib/purecloud/api/groups_api.rb +36 -24
- data/lib/purecloud/api/identity_provider_api.rb +63 -42
- data/lib/purecloud/api/languages_api.rb +21 -12
- data/lib/purecloud/api/locations_api.rb +18 -12
- data/lib/purecloud/api/notifications_api.rb +18 -12
- data/lib/purecloud/api/o_auth_api.rb +18 -12
- data/lib/purecloud/api/outbound_api.rb +220 -148
- data/lib/purecloud/api/presence_api.rb +9 -6
- data/lib/purecloud/api/quality_api.rb +99 -66
- data/lib/purecloud/api/recording_api.rb +54 -36
- data/lib/purecloud/api/response_management_api.rb +45 -30
- data/lib/purecloud/api/routing_api.rb +144 -96
- data/lib/purecloud/api/search_api.rb +90 -60
- data/lib/purecloud/api/suggest_api.rb +36 -24
- data/lib/purecloud/api/telephony_providers_edge_api.rb +288 -192
- data/lib/purecloud/api/user_recordings_api.rb +9 -6
- data/lib/purecloud/api/users_api.rb +145 -100
- data/lib/purecloud/api/utilities_api.rb +9 -6
- data/lib/purecloud/api/voicemail_api.rb +18 -12
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/account.rb +12 -0
- data/lib/purecloud/models/address_listing.rb +17 -17
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/aggregate_metric_data.rb +1 -1
- data/lib/purecloud/models/analytics_conversation_segment.rb +1 -1
- data/lib/purecloud/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloud/models/analytics_session.rb +66 -1
- data/lib/purecloud/models/asset_entity_listing.rb +17 -17
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/available_additional_service_listing.rb +17 -17
- data/lib/purecloud/models/available_topic_entity_listing.rb +17 -17
- data/lib/purecloud/models/billing_address.rb +5 -0
- data/lib/purecloud/models/billing_contact_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/carrier_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/channel_topic_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/consumed_resources_entity_listing.rb +17 -17
- data/lib/purecloud/models/consuming_resources_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_listing.rb +17 -17
- data/lib/purecloud/models/contact_sales.rb +10 -0
- data/lib/purecloud/models/contract.rb +3 -0
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/create_callback_command.rb +18 -8
- data/lib/purecloud/models/create_share_request.rb +1 -1
- data/lib/purecloud/models/create_share_request_member.rb +1 -1
- data/lib/purecloud/models/create_share_response.rb +1 -1
- data/lib/purecloud/models/dependency_object_entity_listing.rb +17 -17
- data/lib/purecloud/models/dependency_type_entity_listing.rb +17 -17
- data/lib/purecloud/models/deployment.rb +209 -0
- data/lib/purecloud/models/deployment_entity_listing.rb +257 -0
- 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.rb +56 -1
- 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_billing_period_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +1 -0
- 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/domain_invoice_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_logical_interface.rb +3 -0
- data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.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_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint.rb +2 -0
- 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/external_contact.rb +11 -1
- data/lib/purecloud/models/external_organization.rb +11 -1
- data/lib/purecloud/models/external_organization_listing.rb +17 -17
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/flow.rb +49 -19
- data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/flow_entity_listing.rb +17 -17
- data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/flow_version_entity_listing.rb +17 -17
- data/lib/purecloud/models/greeting.rb +3 -0
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/hardware_rate_listing.rb +17 -17
- data/lib/purecloud/models/inbound_domain.rb +1 -0
- 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/integration_entity_listing.rb +17 -17
- data/lib/purecloud/models/integration_type_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/ivr_entity_listing.rb +17 -17
- data/lib/purecloud/models/json_node.rb +13 -13
- 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/linked_entity_listing_flow_details.rb +17 -17
- data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +17 -17
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/management_unit.rb +1 -0
- data/lib/purecloud/models/note_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/operation.rb +195 -0
- data/lib/purecloud/models/order.rb +2 -0
- data/lib/purecloud/models/organization_presence.rb +13 -1
- 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.rb +1 -0
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/payment_method.rb +3 -0
- data/lib/purecloud/models/payment_method_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone.rb +3 -0
- data/lib/purecloud/models/phone_base.rb +2 -0
- 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/prompt.rb +11 -1
- data/lib/purecloud/models/prompt_asset_entity_listing.rb +17 -17
- data/lib/purecloud/models/prompt_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/quote.rb +3 -0
- data/lib/purecloud/models/quote_listing.rb +17 -17
- data/lib/purecloud/models/relationship_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.rb +3 -1
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/resource_permission_policy.rb +13 -1
- 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/scene_entity_listing.rb +17 -17
- data/lib/purecloud/models/scene_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/schedule_group_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/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/service_entity_listing.rb +17 -17
- data/lib/purecloud/models/share.rb +12 -2
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site.rb +1 -0
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/social_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +17 -17
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/support_credit_listing.rb +17 -17
- data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +17 -17
- data/lib/purecloud/models/system_prompt_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/template_entity_listing.rb +17 -17
- data/lib/purecloud/models/text_table_transform_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_off_request.rb +356 -0
- data/lib/purecloud/models/time_off_request_list.rb +199 -0
- data/lib/purecloud/models/time_off_request_patch.rb +167 -0
- data/lib/purecloud/models/time_zone_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/twitter_id.rb +213 -0
- data/lib/purecloud/models/user_action_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- 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/video_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/voice_rate_international_entity_listing.rb +17 -17
- data/lib/purecloud/models/voice_xml_operation.rb +11 -1
- data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +17 -17
- data/lib/purecloud/models/waypoint_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 +16 -2
|
@@ -12,10 +12,10 @@ title: TemplateEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<ComposerTemplate>**](ComposerTemplate.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: TextTableTransformEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<ClientTextTableTransform>**](ClientTextTableTransform.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TimeOffRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TimeOffRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **user** | [**User**](User.html) | | [optional] |
|
|
12
|
+
| **is_full_day_request** | **BOOLEAN** | | [optional] [default to false]|
|
|
13
|
+
| **marked_as_read** | **BOOLEAN** | | [optional] [default to false]|
|
|
14
|
+
| **activity_code_id** | **String** | | [optional] |
|
|
15
|
+
| **status** | **String** | | [optional] |
|
|
16
|
+
| **partial_day_start_date_times** | **Array<DateTime>** | | [optional] |
|
|
17
|
+
| **full_day_management_unit_dates** | **Array<String>** | | [optional] |
|
|
18
|
+
| **daily_duration_minutes** | **Integer** | | [optional] |
|
|
19
|
+
| **notes** | **String** | | [optional] |
|
|
20
|
+
| **submitted_by** | [**User**](User.html) | | [optional] |
|
|
21
|
+
| **submitted_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
22
|
+
| **reviewed_by** | [**User**](User.html) | | [optional] |
|
|
23
|
+
| **reviewed_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
24
|
+
| **modified_by** | [**User**](User.html) | | [optional] |
|
|
25
|
+
| **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
26
|
+
| **name** | **String** | | [optional] |
|
|
27
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
28
|
+
{: class="table table-striped"}
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TimeOffRequestList
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TimeOffRequestList
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **time_off_requests** | [**Array<TimeOffRequest>**](TimeOffRequest.html) | | [optional] |
|
|
11
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
12
|
+
| **name** | **String** | | [optional] |
|
|
13
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TimeOffRequestPatch
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TimeOffRequestPatch
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **marked_as_read** | **BOOLEAN** | | [optional] [default to false]|
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -12,10 +12,10 @@ title: TimeZoneEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<TimeZone>**](TimeZone.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: TrunkEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<Trunk>**](Trunk.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: TrunkMetabaseEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<Metabase>**](Metabase.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TwitterExpression
|
|
|
13
13
|
| **date_modified** | **DateTime** | Date the entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **is_dispositioned** | **BOOLEAN** | True once the expression has been dispositioned by an agent through the ACD process | [optional] [default to false]|
|
|
15
15
|
| **is_noise** | **BOOLEAN** | Indicates if a user/agent found this expression to be undesirable | [optional] [default to false]|
|
|
16
|
-
| **gistener** | [**Gistener**](Gistener.html) | The Gistener that generated this expression |
|
|
17
|
-
| **tweet_id** | **String** | Twitter: the tweet's unique id |
|
|
18
|
-
| **text** | **String** | Twitter: the tweets full text |
|
|
16
|
+
| **gistener** | [**Gistener**](Gistener.html) | The Gistener that generated this expression | |
|
|
17
|
+
| **tweet_id** | **String** | Twitter: the tweet's unique id | |
|
|
18
|
+
| **text** | **String** | Twitter: the tweets full text | |
|
|
19
19
|
| **tweet_created** | **DateTime** | Twitter: the date the tweet was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
20
20
|
| **is_reply** | **BOOLEAN** | Twitter: indicates this tweet as a reply to another tweet | [optional] [default to false]|
|
|
21
21
|
| **is_retweet** | **BOOLEAN** | Twitter: indicates this tweet as a 'retweet' of another tweet | [optional] [default to false]|
|
|
@@ -24,7 +24,7 @@ title: TwitterExpression
|
|
|
24
24
|
| **is_quoted_tweet** | **BOOLEAN** | Twitter: indicates this expression as a quoted tweet (a tweet with an addendum as the primary text) | [optional] [default to false]|
|
|
25
25
|
| **quoted_parent_id** | **String** | Twitter: when the expression is a quoted tweet, this is Twitter's id of the original tweet (may not be immediately functional) | [optional] |
|
|
26
26
|
| **user_id** | **String** | Twitter: the expressing user's Twitter id | [optional] |
|
|
27
|
-
| **user_name** | **String** | Twitter: the user's account name for the core service |
|
|
27
|
+
| **user_name** | **String** | Twitter: the user's account name for the core service | |
|
|
28
28
|
| **user_screen_name** | **String** | Twitter: the user's custom 'branding' name (allowed to change over time) | [optional] |
|
|
29
29
|
| **user_tweet_count** | **Integer** | Twitter: the number of times this user has tweeted (includes all forms of expression replies/quotes/retweets) | [optional] |
|
|
30
30
|
| **user_followers_count** | **Integer** | Twitter: the number of followers this user has at the time of this expression | [optional] |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TwitterId
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TwitterId
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | twitter user.id_str | [optional] |
|
|
11
|
+
| **name** | **String** | twitter user.name | [optional] |
|
|
12
|
+
| **screen_name** | **String** | twitter user.screen_name | [optional] |
|
|
13
|
+
| **verified** | **BOOLEAN** | whether this data has been verified using the twitter API | [optional] [default to false]|
|
|
14
|
+
| **profile_url** | **String** | url of user's twitter profile | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -12,10 +12,10 @@ title: UserActionCategoryEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<UserActionCategory>**](UserActionCategory.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,8 +11,8 @@ title: UserActionMetadataEntityListing
|
|
|
11
11
|
| **page_number** | **Integer** | | [optional] |
|
|
12
12
|
| **entities** | [**Array<UserActionMetadata>**](UserActionMetadata.html) | | [optional] |
|
|
13
13
|
| **self_uri** | **String** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **previous_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **page_count** | **Integer** | | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
|
@@ -12,10 +12,10 @@ title: UserEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<User>**](User.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: UserQueueEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<UserQueue>**](UserQueue.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: UserRecordingEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<UserRecording>**](UserRecording.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -304,7 +304,7 @@ Name | Type | Description | Notes
|
|
|
304
304
|
|
|
305
305
|
<a name="put_recording_id"></a>
|
|
306
306
|
|
|
307
|
-
## -[**UserRecording**](UserRecording.html) put_recording_id(recording_id, opts)
|
|
307
|
+
## -[**UserRecording**](UserRecording.html) put_recording_id(recording_id, body, opts)
|
|
308
308
|
|
|
309
309
|
Update a user recording.
|
|
310
310
|
|
|
@@ -329,14 +329,15 @@ api_instance = PureCloud::UserRecordingsApi.new
|
|
|
329
329
|
|
|
330
330
|
recording_id = "recording_id_example" # String | User Recording ID
|
|
331
331
|
|
|
332
|
+
body = PureCloud::UserRecording.new # UserRecording | UserRecording
|
|
333
|
+
|
|
332
334
|
opts = {
|
|
333
|
-
body: PureCloud::UserRecording.new, # UserRecording | UserRecording
|
|
334
335
|
expand: "expand_example" # String | conversation
|
|
335
336
|
}
|
|
336
337
|
|
|
337
338
|
begin
|
|
338
339
|
#Update a user recording.
|
|
339
|
-
result = api_instance.put_recording_id(recording_id, opts)
|
|
340
|
+
result = api_instance.put_recording_id(recording_id, body, opts)
|
|
340
341
|
p result
|
|
341
342
|
rescue PureCloud::ApiError => e
|
|
342
343
|
puts "Exception when calling UserRecordingsApi->put_recording_id: #{e}"
|
|
@@ -348,7 +349,7 @@ end
|
|
|
348
349
|
Name | Type | Description | Notes
|
|
349
350
|
------------- | ------------- | ------------- | -------------
|
|
350
351
|
**recording_id** | **String**| User Recording ID |
|
|
351
|
-
**body** | [**UserRecording**](UserRecording.html)| UserRecording |
|
|
352
|
+
**body** | [**UserRecording**](UserRecording.html)| UserRecording |
|
|
352
353
|
**expand** | **String**| conversation | [optional]
|
|
353
354
|
{: class="table table-striped"}
|
|
354
355
|
|
|
@@ -12,10 +12,10 @@ title: UserSkillEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<UserRoutingSkill>**](UserRoutingSkill.html) | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
15
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **
|
|
16
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/doc_out/UsersApi.html.md
CHANGED
|
@@ -13,9 +13,9 @@ Method | HTTP request | Description
|
|
|
13
13
|
|[**delete_user_id_routingskills_skill_id**](UsersApi.html#delete_user_id_routingskills_skill_id) | **DELETE** /api/v2/users/{userId}/routingskills/{skillId} | Remove routing skill from user|
|
|
14
14
|
|[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | **DELETE** /api/v2/users/{userId}/station/associatedstation | Clear associated station|
|
|
15
15
|
|[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | **DELETE** /api/v2/users/{userId}/station/defaultstation | Clear default station|
|
|
16
|
-
|[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get user.|
|
|
16
|
+
|[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get current user details.|
|
|
17
17
|
|[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search using q64|
|
|
18
|
-
|[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user
|
|
18
|
+
|[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user.|
|
|
19
19
|
|[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user's CallForwarding|
|
|
20
20
|
|[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | **GET** /api/v2/users/{userId}/geolocations/{clientId} | Get a user's Geolocation|
|
|
21
21
|
|[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | **GET** /api/v2/users/{userId}/outofoffice | Get a OutOfOffice|
|
|
@@ -328,9 +328,9 @@ nil (empty response body)
|
|
|
328
328
|
|
|
329
329
|
## -[**UserMe**](UserMe.html) get_me(opts)
|
|
330
330
|
|
|
331
|
-
Get user.
|
|
332
|
-
|
|
331
|
+
Get current user details.
|
|
333
332
|
|
|
333
|
+
This request is not valid when using the Client Credentials OAuth grant.
|
|
334
334
|
|
|
335
335
|
### Example
|
|
336
336
|
~~~ruby
|
|
@@ -350,11 +350,11 @@ end
|
|
|
350
350
|
api_instance = PureCloud::UsersApi.new
|
|
351
351
|
|
|
352
352
|
opts = {
|
|
353
|
-
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
353
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
|
|
354
354
|
}
|
|
355
355
|
|
|
356
356
|
begin
|
|
357
|
-
#Get user.
|
|
357
|
+
#Get current user details.
|
|
358
358
|
result = api_instance.get_me(opts)
|
|
359
359
|
p result
|
|
360
360
|
rescue PureCloud::ApiError => e
|
|
@@ -366,7 +366,7 @@ end
|
|
|
366
366
|
|
|
367
367
|
Name | Type | Description | Notes
|
|
368
368
|
------------- | ------------- | ------------- | -------------
|
|
369
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
369
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional]
|
|
370
370
|
{: class="table table-striped"}
|
|
371
371
|
|
|
372
372
|
|
|
@@ -383,7 +383,7 @@ Name | Type | Description | Notes
|
|
|
383
383
|
|
|
384
384
|
<a name="get_search"></a>
|
|
385
385
|
|
|
386
|
-
## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search(opts)
|
|
386
|
+
## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search(q64, opts)
|
|
387
387
|
|
|
388
388
|
Search using q64
|
|
389
389
|
|
|
@@ -406,14 +406,15 @@ end
|
|
|
406
406
|
|
|
407
407
|
api_instance = PureCloud::UsersApi.new
|
|
408
408
|
|
|
409
|
+
q64 = "q64_example" # String |
|
|
410
|
+
|
|
409
411
|
opts = {
|
|
410
|
-
q64: "q64_example", # String |
|
|
411
412
|
expand: ["expand_example"] # Array<String> |
|
|
412
413
|
}
|
|
413
414
|
|
|
414
415
|
begin
|
|
415
416
|
#Search using q64
|
|
416
|
-
result = api_instance.get_search(opts)
|
|
417
|
+
result = api_instance.get_search(q64, opts)
|
|
417
418
|
p result
|
|
418
419
|
rescue PureCloud::ApiError => e
|
|
419
420
|
puts "Exception when calling UsersApi->get_search: #{e}"
|
|
@@ -424,7 +425,7 @@ end
|
|
|
424
425
|
|
|
425
426
|
Name | Type | Description | Notes
|
|
426
427
|
------------- | ------------- | ------------- | -------------
|
|
427
|
-
**q64** | **String**| |
|
|
428
|
+
**q64** | **String**| |
|
|
428
429
|
**expand** | [**Array<String>**](String.html)| | [optional]
|
|
429
430
|
{: class="table table-striped"}
|
|
430
431
|
|
|
@@ -444,7 +445,7 @@ Name | Type | Description | Notes
|
|
|
444
445
|
|
|
445
446
|
## -[**User**](User.html) get_user_id(user_id, opts)
|
|
446
447
|
|
|
447
|
-
Get user
|
|
448
|
+
Get user.
|
|
448
449
|
|
|
449
450
|
|
|
450
451
|
|
|
@@ -472,7 +473,7 @@ opts = {
|
|
|
472
473
|
}
|
|
473
474
|
|
|
474
475
|
begin
|
|
475
|
-
#Get user
|
|
476
|
+
#Get user.
|
|
476
477
|
result = api_instance.get_user_id(user_id, opts)
|
|
477
478
|
p result
|
|
478
479
|
rescue PureCloud::ApiError => e
|
|
@@ -993,7 +994,7 @@ api_instance = PureCloud::UsersApi.new
|
|
|
993
994
|
opts = {
|
|
994
995
|
page_size: 25, # Integer | Page size
|
|
995
996
|
page_number: 1, # Integer | Page number
|
|
996
|
-
id: ["id_example"], # Array<String> |
|
|
997
|
+
id: ["id_example"], # Array<String> | id
|
|
997
998
|
sort_order: "ASC", # String | Ascending or descending sort order
|
|
998
999
|
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
999
1000
|
}
|
|
@@ -1013,7 +1014,7 @@ Name | Type | Description | Notes
|
|
|
1013
1014
|
------------- | ------------- | ------------- | -------------
|
|
1014
1015
|
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
1015
1016
|
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
1016
|
-
**id** | [**Array<String>**](String.html)|
|
|
1017
|
+
**id** | [**Array<String>**](String.html)| id | [optional]
|
|
1017
1018
|
**sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]
|
|
1018
1019
|
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
1019
1020
|
{: class="table table-striped"}
|
|
@@ -1032,7 +1033,7 @@ Name | Type | Description | Notes
|
|
|
1032
1033
|
|
|
1033
1034
|
<a name="patch_user_id"></a>
|
|
1034
1035
|
|
|
1035
|
-
## -[**User**](User.html) patch_user_id(user_id,
|
|
1036
|
+
## -[**User**](User.html) patch_user_id(user_id, body)
|
|
1036
1037
|
|
|
1037
1038
|
Update user
|
|
1038
1039
|
|
|
@@ -1057,13 +1058,12 @@ api_instance = PureCloud::UsersApi.new
|
|
|
1057
1058
|
|
|
1058
1059
|
user_id = "user_id_example" # String | User ID
|
|
1059
1060
|
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
}
|
|
1061
|
+
body = PureCloud::User.new # User | User
|
|
1062
|
+
|
|
1063
1063
|
|
|
1064
1064
|
begin
|
|
1065
1065
|
#Update user
|
|
1066
|
-
result = api_instance.patch_user_id(user_id,
|
|
1066
|
+
result = api_instance.patch_user_id(user_id, body)
|
|
1067
1067
|
p result
|
|
1068
1068
|
rescue PureCloud::ApiError => e
|
|
1069
1069
|
puts "Exception when calling UsersApi->patch_user_id: #{e}"
|
|
@@ -1075,7 +1075,7 @@ end
|
|
|
1075
1075
|
Name | Type | Description | Notes
|
|
1076
1076
|
------------- | ------------- | ------------- | -------------
|
|
1077
1077
|
**user_id** | **String**| User ID |
|
|
1078
|
-
**body** | [**User**](User.html)|
|
|
1078
|
+
**body** | [**User**](User.html)| User |
|
|
1079
1079
|
{: class="table table-striped"}
|
|
1080
1080
|
|
|
1081
1081
|
|
|
@@ -1092,7 +1092,7 @@ Name | Type | Description | Notes
|
|
|
1092
1092
|
|
|
1093
1093
|
<a name="patch_user_id_callforwarding"></a>
|
|
1094
1094
|
|
|
1095
|
-
## -[**CallForwarding**](CallForwarding.html) patch_user_id_callforwarding(user_id,
|
|
1095
|
+
## -[**CallForwarding**](CallForwarding.html) patch_user_id_callforwarding(user_id, body)
|
|
1096
1096
|
|
|
1097
1097
|
Patch a user's CallForwarding
|
|
1098
1098
|
|
|
@@ -1117,13 +1117,12 @@ api_instance = PureCloud::UsersApi.new
|
|
|
1117
1117
|
|
|
1118
1118
|
user_id = "user_id_example" # String | User ID
|
|
1119
1119
|
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
}
|
|
1120
|
+
body = PureCloud::CallForwarding.new # CallForwarding | Call forwarding
|
|
1121
|
+
|
|
1123
1122
|
|
|
1124
1123
|
begin
|
|
1125
1124
|
#Patch a user's CallForwarding
|
|
1126
|
-
result = api_instance.patch_user_id_callforwarding(user_id,
|
|
1125
|
+
result = api_instance.patch_user_id_callforwarding(user_id, body)
|
|
1127
1126
|
p result
|
|
1128
1127
|
rescue PureCloud::ApiError => e
|
|
1129
1128
|
puts "Exception when calling UsersApi->patch_user_id_callforwarding: #{e}"
|
|
@@ -1135,7 +1134,7 @@ end
|
|
|
1135
1134
|
Name | Type | Description | Notes
|
|
1136
1135
|
------------- | ------------- | ------------- | -------------
|
|
1137
1136
|
**user_id** | **String**| User ID |
|
|
1138
|
-
**body** | [**CallForwarding**](CallForwarding.html)|
|
|
1137
|
+
**body** | [**CallForwarding**](CallForwarding.html)| Call forwarding |
|
|
1139
1138
|
{: class="table table-striped"}
|
|
1140
1139
|
|
|
1141
1140
|
|
|
@@ -1152,7 +1151,7 @@ Name | Type | Description | Notes
|
|
|
1152
1151
|
|
|
1153
1152
|
<a name="patch_user_id_geolocations_client_id"></a>
|
|
1154
1153
|
|
|
1155
|
-
## -[**Geolocation**](Geolocation.html) patch_user_id_geolocations_client_id(user_id, client_id,
|
|
1154
|
+
## -[**Geolocation**](Geolocation.html) patch_user_id_geolocations_client_id(user_id, client_id, body)
|
|
1156
1155
|
|
|
1157
1156
|
Patch a user's Geolocation
|
|
1158
1157
|
|
|
@@ -1179,13 +1178,12 @@ user_id = "user_id_example" # String | user Id
|
|
|
1179
1178
|
|
|
1180
1179
|
client_id = "client_id_example" # String | client Id
|
|
1181
1180
|
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
}
|
|
1181
|
+
body = PureCloud::Geolocation.new # Geolocation | Geolocation
|
|
1182
|
+
|
|
1185
1183
|
|
|
1186
1184
|
begin
|
|
1187
1185
|
#Patch a user's Geolocation
|
|
1188
|
-
result = api_instance.patch_user_id_geolocations_client_id(user_id, client_id,
|
|
1186
|
+
result = api_instance.patch_user_id_geolocations_client_id(user_id, client_id, body)
|
|
1189
1187
|
p result
|
|
1190
1188
|
rescue PureCloud::ApiError => e
|
|
1191
1189
|
puts "Exception when calling UsersApi->patch_user_id_geolocations_client_id: #{e}"
|
|
@@ -1198,7 +1196,7 @@ Name | Type | Description | Notes
|
|
|
1198
1196
|
------------- | ------------- | ------------- | -------------
|
|
1199
1197
|
**user_id** | **String**| user Id |
|
|
1200
1198
|
**client_id** | **String**| client Id |
|
|
1201
|
-
**body** | [**Geolocation**](Geolocation.html)|
|
|
1199
|
+
**body** | [**Geolocation**](Geolocation.html)| Geolocation |
|
|
1202
1200
|
{: class="table table-striped"}
|
|
1203
1201
|
|
|
1204
1202
|
|
|
@@ -1215,7 +1213,7 @@ Name | Type | Description | Notes
|
|
|
1215
1213
|
|
|
1216
1214
|
<a name="patch_user_id_queues"></a>
|
|
1217
1215
|
|
|
1218
|
-
## -[**UserQueue**](UserQueue.html) patch_user_id_queues(user_id,
|
|
1216
|
+
## -[**UserQueue**](UserQueue.html) patch_user_id_queues(user_id, body)
|
|
1219
1217
|
|
|
1220
1218
|
Join or unjoin a set of queues for a user
|
|
1221
1219
|
|
|
@@ -1240,13 +1238,12 @@ api_instance = PureCloud::UsersApi.new
|
|
|
1240
1238
|
|
|
1241
1239
|
user_id = "user_id_example" # String | User ID
|
|
1242
1240
|
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
}
|
|
1241
|
+
body = [PureCloud::UserQueue.new] # Array<UserQueue> | User Queues
|
|
1242
|
+
|
|
1246
1243
|
|
|
1247
1244
|
begin
|
|
1248
1245
|
#Join or unjoin a set of queues for a user
|
|
1249
|
-
result = api_instance.patch_user_id_queues(user_id,
|
|
1246
|
+
result = api_instance.patch_user_id_queues(user_id, body)
|
|
1250
1247
|
p result
|
|
1251
1248
|
rescue PureCloud::ApiError => e
|
|
1252
1249
|
puts "Exception when calling UsersApi->patch_user_id_queues: #{e}"
|
|
@@ -1258,7 +1255,7 @@ end
|
|
|
1258
1255
|
Name | Type | Description | Notes
|
|
1259
1256
|
------------- | ------------- | ------------- | -------------
|
|
1260
1257
|
**user_id** | **String**| User ID |
|
|
1261
|
-
**body** | [**Array<UserQueue>**](UserQueue.html)| User Queues |
|
|
1258
|
+
**body** | [**Array<UserQueue>**](UserQueue.html)| User Queues |
|
|
1262
1259
|
{: class="table table-striped"}
|
|
1263
1260
|
|
|
1264
1261
|
|
|
@@ -1275,7 +1272,7 @@ Name | Type | Description | Notes
|
|
|
1275
1272
|
|
|
1276
1273
|
<a name="patch_user_id_queues_queue_id"></a>
|
|
1277
1274
|
|
|
1278
|
-
## -[**UserQueue**](UserQueue.html) patch_user_id_queues_queue_id(queue_id, user_id,
|
|
1275
|
+
## -[**UserQueue**](UserQueue.html) patch_user_id_queues_queue_id(queue_id, user_id, body)
|
|
1279
1276
|
|
|
1280
1277
|
Join or unjoin a queue for a user
|
|
1281
1278
|
|
|
@@ -1302,13 +1299,12 @@ queue_id = "queue_id_example" # String | Queue ID
|
|
|
1302
1299
|
|
|
1303
1300
|
user_id = "user_id_example" # String | User ID
|
|
1304
1301
|
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
}
|
|
1302
|
+
body = PureCloud::UserQueue.new # UserQueue | Queue Member
|
|
1303
|
+
|
|
1308
1304
|
|
|
1309
1305
|
begin
|
|
1310
1306
|
#Join or unjoin a queue for a user
|
|
1311
|
-
result = api_instance.patch_user_id_queues_queue_id(queue_id, user_id,
|
|
1307
|
+
result = api_instance.patch_user_id_queues_queue_id(queue_id, user_id, body)
|
|
1312
1308
|
p result
|
|
1313
1309
|
rescue PureCloud::ApiError => e
|
|
1314
1310
|
puts "Exception when calling UsersApi->patch_user_id_queues_queue_id: #{e}"
|
|
@@ -1321,7 +1317,7 @@ Name | Type | Description | Notes
|
|
|
1321
1317
|
------------- | ------------- | ------------- | -------------
|
|
1322
1318
|
**queue_id** | **String**| Queue ID |
|
|
1323
1319
|
**user_id** | **String**| User ID |
|
|
1324
|
-
**body** | [**UserQueue**](UserQueue.html)| Queue Member |
|
|
1320
|
+
**body** | [**UserQueue**](UserQueue.html)| Queue Member |
|
|
1325
1321
|
{: class="table table-striped"}
|
|
1326
1322
|
|
|
1327
1323
|
|
|
@@ -1338,7 +1334,7 @@ Name | Type | Description | Notes
|
|
|
1338
1334
|
|
|
1339
1335
|
<a name="post_search"></a>
|
|
1340
1336
|
|
|
1341
|
-
## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search(
|
|
1337
|
+
## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search(body)
|
|
1342
1338
|
|
|
1343
1339
|
Search
|
|
1344
1340
|
|
|
@@ -1361,13 +1357,12 @@ end
|
|
|
1361
1357
|
|
|
1362
1358
|
api_instance = PureCloud::UsersApi.new
|
|
1363
1359
|
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
}
|
|
1360
|
+
body = PureCloud::UserSearchRequest.new # UserSearchRequest | Search request options
|
|
1361
|
+
|
|
1367
1362
|
|
|
1368
1363
|
begin
|
|
1369
1364
|
#Search
|
|
1370
|
-
result = api_instance.post_search(
|
|
1365
|
+
result = api_instance.post_search(body)
|
|
1371
1366
|
p result
|
|
1372
1367
|
rescue PureCloud::ApiError => e
|
|
1373
1368
|
puts "Exception when calling UsersApi->post_search: #{e}"
|
|
@@ -1378,7 +1373,7 @@ end
|
|
|
1378
1373
|
|
|
1379
1374
|
Name | Type | Description | Notes
|
|
1380
1375
|
------------- | ------------- | ------------- | -------------
|
|
1381
|
-
**body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options |
|
|
1376
|
+
**body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options |
|
|
1382
1377
|
{: class="table table-striped"}
|
|
1383
1378
|
|
|
1384
1379
|
|
|
@@ -1395,7 +1390,7 @@ Name | Type | Description | Notes
|
|
|
1395
1390
|
|
|
1396
1391
|
<a name="post_user_id_routingskills"></a>
|
|
1397
1392
|
|
|
1398
|
-
## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_id_routingskills(user_id,
|
|
1393
|
+
## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_id_routingskills(user_id, body)
|
|
1399
1394
|
|
|
1400
1395
|
Add routing skill to user
|
|
1401
1396
|
|
|
@@ -1420,13 +1415,12 @@ api_instance = PureCloud::UsersApi.new
|
|
|
1420
1415
|
|
|
1421
1416
|
user_id = "user_id_example" # String | User ID
|
|
1422
1417
|
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
}
|
|
1418
|
+
body = PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill
|
|
1419
|
+
|
|
1426
1420
|
|
|
1427
1421
|
begin
|
|
1428
1422
|
#Add routing skill to user
|
|
1429
|
-
result = api_instance.post_user_id_routingskills(user_id,
|
|
1423
|
+
result = api_instance.post_user_id_routingskills(user_id, body)
|
|
1430
1424
|
p result
|
|
1431
1425
|
rescue PureCloud::ApiError => e
|
|
1432
1426
|
puts "Exception when calling UsersApi->post_user_id_routingskills: #{e}"
|
|
@@ -1438,7 +1432,7 @@ end
|
|
|
1438
1432
|
Name | Type | Description | Notes
|
|
1439
1433
|
------------- | ------------- | ------------- | -------------
|
|
1440
1434
|
**user_id** | **String**| User ID |
|
|
1441
|
-
**body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill |
|
|
1435
|
+
**body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill |
|
|
1442
1436
|
{: class="table table-striped"}
|
|
1443
1437
|
|
|
1444
1438
|
|
|
@@ -1455,7 +1449,7 @@ Name | Type | Description | Notes
|
|
|
1455
1449
|
|
|
1456
1450
|
<a name="post_users"></a>
|
|
1457
1451
|
|
|
1458
|
-
## -[**User**](User.html) post_users(
|
|
1452
|
+
## -[**User**](User.html) post_users(body)
|
|
1459
1453
|
|
|
1460
1454
|
Create user
|
|
1461
1455
|
|
|
@@ -1478,13 +1472,12 @@ end
|
|
|
1478
1472
|
|
|
1479
1473
|
api_instance = PureCloud::UsersApi.new
|
|
1480
1474
|
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
}
|
|
1475
|
+
body = PureCloud::CreateUser.new # CreateUser | User
|
|
1476
|
+
|
|
1484
1477
|
|
|
1485
1478
|
begin
|
|
1486
1479
|
#Create user
|
|
1487
|
-
result = api_instance.post_users(
|
|
1480
|
+
result = api_instance.post_users(body)
|
|
1488
1481
|
p result
|
|
1489
1482
|
rescue PureCloud::ApiError => e
|
|
1490
1483
|
puts "Exception when calling UsersApi->post_users: #{e}"
|
|
@@ -1495,7 +1488,7 @@ end
|
|
|
1495
1488
|
|
|
1496
1489
|
Name | Type | Description | Notes
|
|
1497
1490
|
------------- | ------------- | ------------- | -------------
|
|
1498
|
-
**body** | [**CreateUser**](CreateUser.html)| User |
|
|
1491
|
+
**body** | [**CreateUser**](CreateUser.html)| User |
|
|
1499
1492
|
{: class="table table-striped"}
|
|
1500
1493
|
|
|
1501
1494
|
|
|
@@ -1512,7 +1505,7 @@ Name | Type | Description | Notes
|
|
|
1512
1505
|
|
|
1513
1506
|
<a name="post_users_aggregates_query"></a>
|
|
1514
1507
|
|
|
1515
|
-
## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(
|
|
1508
|
+
## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(body)
|
|
1516
1509
|
|
|
1517
1510
|
Query for user aggregates
|
|
1518
1511
|
|
|
@@ -1535,13 +1528,12 @@ end
|
|
|
1535
1528
|
|
|
1536
1529
|
api_instance = PureCloud::UsersApi.new
|
|
1537
1530
|
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
}
|
|
1531
|
+
body = PureCloud::AggregationQuery.new # AggregationQuery | query
|
|
1532
|
+
|
|
1541
1533
|
|
|
1542
1534
|
begin
|
|
1543
1535
|
#Query for user aggregates
|
|
1544
|
-
result = api_instance.post_users_aggregates_query(
|
|
1536
|
+
result = api_instance.post_users_aggregates_query(body)
|
|
1545
1537
|
p result
|
|
1546
1538
|
rescue PureCloud::ApiError => e
|
|
1547
1539
|
puts "Exception when calling UsersApi->post_users_aggregates_query: #{e}"
|
|
@@ -1552,7 +1544,7 @@ end
|
|
|
1552
1544
|
|
|
1553
1545
|
Name | Type | Description | Notes
|
|
1554
1546
|
------------- | ------------- | ------------- | -------------
|
|
1555
|
-
**body** | [**AggregationQuery**](AggregationQuery.html)| query |
|
|
1547
|
+
**body** | [**AggregationQuery**](AggregationQuery.html)| query |
|
|
1556
1548
|
{: class="table table-striped"}
|
|
1557
1549
|
|
|
1558
1550
|
|
|
@@ -1569,7 +1561,7 @@ Name | Type | Description | Notes
|
|
|
1569
1561
|
|
|
1570
1562
|
<a name="post_users_observations_query"></a>
|
|
1571
1563
|
|
|
1572
|
-
## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(
|
|
1564
|
+
## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(body)
|
|
1573
1565
|
|
|
1574
1566
|
Query for user observations
|
|
1575
1567
|
|
|
@@ -1592,13 +1584,12 @@ end
|
|
|
1592
1584
|
|
|
1593
1585
|
api_instance = PureCloud::UsersApi.new
|
|
1594
1586
|
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
}
|
|
1587
|
+
body = PureCloud::ObservationQuery.new # ObservationQuery | query
|
|
1588
|
+
|
|
1598
1589
|
|
|
1599
1590
|
begin
|
|
1600
1591
|
#Query for user observations
|
|
1601
|
-
result = api_instance.post_users_observations_query(
|
|
1592
|
+
result = api_instance.post_users_observations_query(body)
|
|
1602
1593
|
p result
|
|
1603
1594
|
rescue PureCloud::ApiError => e
|
|
1604
1595
|
puts "Exception when calling UsersApi->post_users_observations_query: #{e}"
|
|
@@ -1609,7 +1600,7 @@ end
|
|
|
1609
1600
|
|
|
1610
1601
|
Name | Type | Description | Notes
|
|
1611
1602
|
------------- | ------------- | ------------- | -------------
|
|
1612
|
-
**body** | [**ObservationQuery**](ObservationQuery.html)| query |
|
|
1603
|
+
**body** | [**ObservationQuery**](ObservationQuery.html)| query |
|
|
1613
1604
|
{: class="table table-striped"}
|
|
1614
1605
|
|
|
1615
1606
|
|
|
@@ -1626,7 +1617,7 @@ Name | Type | Description | Notes
|
|
|
1626
1617
|
|
|
1627
1618
|
<a name="put_user_id_callforwarding"></a>
|
|
1628
1619
|
|
|
1629
|
-
## -[**CallForwarding**](CallForwarding.html) put_user_id_callforwarding(user_id,
|
|
1620
|
+
## -[**CallForwarding**](CallForwarding.html) put_user_id_callforwarding(user_id, body)
|
|
1630
1621
|
|
|
1631
1622
|
Update a user's CallForwarding
|
|
1632
1623
|
|
|
@@ -1651,13 +1642,12 @@ api_instance = PureCloud::UsersApi.new
|
|
|
1651
1642
|
|
|
1652
1643
|
user_id = "user_id_example" # String | User ID
|
|
1653
1644
|
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
}
|
|
1645
|
+
body = PureCloud::CallForwarding.new # CallForwarding | Call forwarding
|
|
1646
|
+
|
|
1657
1647
|
|
|
1658
1648
|
begin
|
|
1659
1649
|
#Update a user's CallForwarding
|
|
1660
|
-
result = api_instance.put_user_id_callforwarding(user_id,
|
|
1650
|
+
result = api_instance.put_user_id_callforwarding(user_id, body)
|
|
1661
1651
|
p result
|
|
1662
1652
|
rescue PureCloud::ApiError => e
|
|
1663
1653
|
puts "Exception when calling UsersApi->put_user_id_callforwarding: #{e}"
|
|
@@ -1669,7 +1659,7 @@ end
|
|
|
1669
1659
|
Name | Type | Description | Notes
|
|
1670
1660
|
------------- | ------------- | ------------- | -------------
|
|
1671
1661
|
**user_id** | **String**| User ID |
|
|
1672
|
-
**body** | [**CallForwarding**](CallForwarding.html)|
|
|
1662
|
+
**body** | [**CallForwarding**](CallForwarding.html)| Call forwarding |
|
|
1673
1663
|
{: class="table table-striped"}
|
|
1674
1664
|
|
|
1675
1665
|
|
|
@@ -1745,7 +1735,7 @@ Name | Type | Description | Notes
|
|
|
1745
1735
|
|
|
1746
1736
|
<a name="put_user_id_roles"></a>
|
|
1747
1737
|
|
|
1748
|
-
## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id,
|
|
1738
|
+
## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, body)
|
|
1749
1739
|
|
|
1750
1740
|
Sets the user's roles
|
|
1751
1741
|
|
|
@@ -1770,13 +1760,12 @@ api_instance = PureCloud::UsersApi.new
|
|
|
1770
1760
|
|
|
1771
1761
|
user_id = "user_id_example" # String | User ID
|
|
1772
1762
|
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
}
|
|
1763
|
+
body = [PureCloud::Array<String>.new] # Array<String> | List of roles
|
|
1764
|
+
|
|
1776
1765
|
|
|
1777
1766
|
begin
|
|
1778
1767
|
#Sets the user's roles
|
|
1779
|
-
result = api_instance.put_user_id_roles(user_id,
|
|
1768
|
+
result = api_instance.put_user_id_roles(user_id, body)
|
|
1780
1769
|
p result
|
|
1781
1770
|
rescue PureCloud::ApiError => e
|
|
1782
1771
|
puts "Exception when calling UsersApi->put_user_id_roles: #{e}"
|
|
@@ -1788,7 +1777,7 @@ end
|
|
|
1788
1777
|
Name | Type | Description | Notes
|
|
1789
1778
|
------------- | ------------- | ------------- | -------------
|
|
1790
1779
|
**user_id** | **String**| User ID |
|
|
1791
|
-
**body** | **Array<String>**|
|
|
1780
|
+
**body** | **Array<String>**| List of roles |
|
|
1792
1781
|
{: class="table table-striped"}
|
|
1793
1782
|
|
|
1794
1783
|
|
|
@@ -1805,7 +1794,7 @@ Name | Type | Description | Notes
|
|
|
1805
1794
|
|
|
1806
1795
|
<a name="put_user_id_routingskills_skill_id"></a>
|
|
1807
1796
|
|
|
1808
|
-
## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_id_routingskills_skill_id(user_id, skill_id,
|
|
1797
|
+
## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_id_routingskills_skill_id(user_id, skill_id, body)
|
|
1809
1798
|
|
|
1810
1799
|
Update routing skill proficiency or state.
|
|
1811
1800
|
|
|
@@ -1832,13 +1821,12 @@ user_id = "user_id_example" # String | User ID
|
|
|
1832
1821
|
|
|
1833
1822
|
skill_id = "skill_id_example" # String |
|
|
1834
1823
|
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
}
|
|
1824
|
+
body = PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill
|
|
1825
|
+
|
|
1838
1826
|
|
|
1839
1827
|
begin
|
|
1840
1828
|
#Update routing skill proficiency or state.
|
|
1841
|
-
result = api_instance.put_user_id_routingskills_skill_id(user_id, skill_id,
|
|
1829
|
+
result = api_instance.put_user_id_routingskills_skill_id(user_id, skill_id, body)
|
|
1842
1830
|
p result
|
|
1843
1831
|
rescue PureCloud::ApiError => e
|
|
1844
1832
|
puts "Exception when calling UsersApi->put_user_id_routingskills_skill_id: #{e}"
|
|
@@ -1851,7 +1839,7 @@ Name | Type | Description | Notes
|
|
|
1851
1839
|
------------- | ------------- | ------------- | -------------
|
|
1852
1840
|
**user_id** | **String**| User ID |
|
|
1853
1841
|
**skill_id** | **String**| |
|
|
1854
|
-
**body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill |
|
|
1842
|
+
**body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill |
|
|
1855
1843
|
{: class="table table-striped"}
|
|
1856
1844
|
|
|
1857
1845
|
|
|
@@ -1868,7 +1856,7 @@ Name | Type | Description | Notes
|
|
|
1868
1856
|
|
|
1869
1857
|
<a name="put_user_id_routingstatus"></a>
|
|
1870
1858
|
|
|
1871
|
-
## -[**RoutingStatus**](RoutingStatus.html) put_user_id_routingstatus(user_id,
|
|
1859
|
+
## -[**RoutingStatus**](RoutingStatus.html) put_user_id_routingstatus(user_id, body)
|
|
1872
1860
|
|
|
1873
1861
|
Update the routing status of a user
|
|
1874
1862
|
|
|
@@ -1893,13 +1881,12 @@ api_instance = PureCloud::UsersApi.new
|
|
|
1893
1881
|
|
|
1894
1882
|
user_id = "user_id_example" # String | User ID
|
|
1895
1883
|
|
|
1896
|
-
|
|
1897
|
-
|
|
1898
|
-
}
|
|
1884
|
+
body = PureCloud::RoutingStatus.new # RoutingStatus | Routing Status
|
|
1885
|
+
|
|
1899
1886
|
|
|
1900
1887
|
begin
|
|
1901
1888
|
#Update the routing status of a user
|
|
1902
|
-
result = api_instance.put_user_id_routingstatus(user_id,
|
|
1889
|
+
result = api_instance.put_user_id_routingstatus(user_id, body)
|
|
1903
1890
|
p result
|
|
1904
1891
|
rescue PureCloud::ApiError => e
|
|
1905
1892
|
puts "Exception when calling UsersApi->put_user_id_routingstatus: #{e}"
|
|
@@ -1911,7 +1898,7 @@ end
|
|
|
1911
1898
|
Name | Type | Description | Notes
|
|
1912
1899
|
------------- | ------------- | ------------- | -------------
|
|
1913
1900
|
**user_id** | **String**| User ID |
|
|
1914
|
-
**body** | [**RoutingStatus**](RoutingStatus.html)| Routing Status |
|
|
1901
|
+
**body** | [**RoutingStatus**](RoutingStatus.html)| Routing Status |
|
|
1915
1902
|
{: class="table table-striped"}
|
|
1916
1903
|
|
|
1917
1904
|
|