purecloud 0.50.1 → 0.51.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 +6 -6
- data/bin/notificationMappings.json +96 -0
- data/config-ruby.json +1 -1
- data/doc_out/AcwSettings.html.md +2 -2
- data/doc_out/Address.html.md +17 -0
- data/doc_out/Agent.html.md +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +445 -0
- data/doc_out/AttemptLimits.html.md +22 -0
- data/doc_out/AttemptLimitsEntityListing.html.md +22 -0
- data/doc_out/Attribute.html.md +1 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AuditEntity.html.md +4 -4
- data/doc_out/AuditFacet.html.md +2 -2
- data/doc_out/AuditFilter.html.md +4 -4
- data/doc_out/AuditMessage.html.md +14 -14
- data/doc_out/AuditSearchResult.html.md +4 -4
- data/doc_out/AuditUser.html.md +3 -3
- data/doc_out/AuthorizationApi.html.md +2 -2
- data/doc_out/AvailableTopicEntityListing.html.md +2 -2
- data/doc_out/CalibrationCreate.html.md +28 -0
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/Call.html.md +17 -17
- data/doc_out/CallCommand.html.md +1 -1
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotification.html.md +17 -0
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +44 -0
- data/doc_out/CallConversationNotificationDetail.html.md +16 -0
- data/doc_out/CallConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CallConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CallConversationNotificationFaxStatus.html.md +20 -0
- data/doc_out/CallConversationNotificationParticipants.html.md +44 -0
- data/doc_out/CallConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CallMediaParticipant.html.md +6 -3
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/Callback.html.md +16 -16
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotification.html.md +16 -0
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +39 -0
- data/doc_out/CallbackConversationNotificationDetail.html.md +16 -0
- data/doc_out/CallbackConversationNotificationDialerPreview.html.md +18 -0
- data/doc_out/CallbackConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CallbackConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CallbackConversationNotificationErrorInfoDetails.html.md +16 -0
- data/doc_out/CallbackConversationNotificationParticipants.html.md +39 -0
- data/doc_out/CallbackConversationNotificationPhoneNumberColumn.html.md +15 -0
- data/doc_out/CallbackConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CallbackConversationNotificationUser.html.md +14 -0
- data/doc_out/CallbackMediaParticipant.html.md +6 -3
- data/doc_out/Campaign.html.md +1 -0
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignInteraction.html.md +33 -0
- data/doc_out/CampaignInteractions.html.md +17 -0
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/Change.html.md +3 -3
- 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/ChatConversationNotification.html.md +16 -0
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +34 -0
- data/doc_out/ChatConversationNotificationDetail.html.md +16 -0
- data/doc_out/ChatConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/ChatConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/ChatConversationNotificationParticipants.html.md +34 -0
- data/doc_out/ChatConversationNotificationUriReference.html.md +14 -0
- data/doc_out/ChatMediaParticipant.html.md +6 -3
- data/doc_out/CobrowseConversation.html.md +17 -0
- data/doc_out/CobrowseConversationEntityListing.html.md +22 -0
- data/doc_out/CobrowseConversationNotification.html.md +16 -0
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +38 -0
- data/doc_out/CobrowseConversationNotificationDetail.html.md +16 -0
- data/doc_out/CobrowseConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CobrowseConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +38 -0
- data/doc_out/CobrowseConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CobrowseMediaParticipant.html.md +41 -0
- data/doc_out/Cobrowsesession.html.md +23 -0
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ContentManagementApi.html.md +34 -33
- data/doc_out/ConversationChat.html.md +12 -11
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationNotification.html.md +17 -0
- data/doc_out/ConversationNotificationAddress.html.md +18 -0
- data/doc_out/ConversationNotificationCall.html.md +31 -0
- data/doc_out/ConversationNotificationCallback.html.md +28 -0
- data/doc_out/ConversationNotificationCallbacks.html.md +28 -0
- data/doc_out/ConversationNotificationCalls.html.md +31 -0
- data/doc_out/ConversationNotificationChat.html.md +21 -0
- data/doc_out/ConversationNotificationChats.html.md +21 -0
- data/doc_out/ConversationNotificationCobrowse.html.md +25 -0
- data/doc_out/ConversationNotificationCobrowsesessions.html.md +25 -0
- data/doc_out/ConversationNotificationDialerPreview.html.md +18 -0
- data/doc_out/ConversationNotificationDialerPreviewPhoneNumberColumns.html.md +15 -0
- data/doc_out/ConversationNotificationDisconnectReason.html.md +15 -0
- data/doc_out/ConversationNotificationDisconnectReasons.html.md +15 -0
- data/doc_out/ConversationNotificationEmail.html.md +23 -0
- data/doc_out/ConversationNotificationEmails.html.md +23 -0
- data/doc_out/ConversationNotificationErrorDetails.html.md +20 -0
- data/doc_out/ConversationNotificationErrorInfo.html.md +20 -0
- data/doc_out/ConversationNotificationFaxStatus.html.md +20 -0
- data/doc_out/ConversationNotificationParticipant.html.md +39 -0
- data/doc_out/ConversationNotificationParticipants.html.md +39 -0
- data/doc_out/ConversationNotificationPhoneNumberColumn.html.md +15 -0
- data/doc_out/ConversationNotificationScreenShare.html.md +21 -0
- data/doc_out/ConversationNotificationScreenShares.html.md +21 -0
- data/doc_out/ConversationNotificationSelf.html.md +18 -0
- data/doc_out/ConversationNotificationSocialExpression.html.md +25 -0
- data/doc_out/ConversationNotificationSocialExpressions.html.md +25 -0
- data/doc_out/ConversationNotificationVideo.html.md +24 -0
- data/doc_out/ConversationNotificationVideos.html.md +24 -0
- data/doc_out/ConversationNotificationWrapup.html.md +18 -0
- data/doc_out/ConversationsApi.html.md +707 -161
- data/doc_out/CreateCallbackCommand.html.md +1 -1
- data/doc_out/CreateShareRequest.html.md +3 -3
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DialerAuditRequest.html.md +4 -4
- data/doc_out/DialerContact.html.md +1 -1
- data/doc_out/DialerPreview.html.md +4 -4
- data/doc_out/DisconnectReason.html.md +3 -3
- data/doc_out/DncList.html.md +1 -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/DocumentUpdate.html.md +1 -1
- data/doc_out/DocumentUpload.html.md +2 -2
- data/doc_out/DomainCapabilities.html.md +5 -3
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +1 -1
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +22 -0
- 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/DomainLogicalInterface.html.md +5 -8
- data/doc_out/DomainNetworkAddress.html.md +4 -4
- data/doc_out/DomainNetworkRoute.html.md +5 -5
- data/doc_out/DomainOrganizationRoleCreate.html.md +22 -0
- data/doc_out/Edge.html.md +2 -1
- 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/EdgeLogsJobRequest.html.md +3 -3
- data/doc_out/EdgeLogsJobUploadRequest.html.md +1 -1
- data/doc_out/EdgeOfflineConfiguration.html.md +14 -0
- data/doc_out/EdgeOfflineConfigurationInterface.html.md +16 -0
- data/doc_out/EdgeOfflineConfigurationNetwork.html.md +13 -0
- data/doc_out/EdgeOfflineConfigurationResponse.html.md +13 -0
- data/doc_out/Email.html.md +13 -12
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotification.html.md +16 -0
- data/doc_out/EmailConversationNotificationDetail.html.md +16 -0
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +35 -0
- data/doc_out/EmailConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/EmailConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/EmailConversationNotificationParticipants.html.md +35 -0
- data/doc_out/EmailConversationNotificationUriReference.html.md +14 -0
- data/doc_out/EmailMediaParticipant.html.md +6 -3
- data/doc_out/EmailMessage.html.md +3 -3
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationForm.html.md +3 -3
- 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/FacetInfo.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/FaxStatus.html.md +8 -8
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupMembersUpdate.html.md +2 -2
- data/doc_out/GroupUpdate.html.md +22 -0
- data/doc_out/GroupsApi.html.md +122 -4
- data/doc_out/HeartBeatAlert.html.md +24 -0
- data/doc_out/HeartBeatAlertContainer.html.md +22 -0
- data/doc_out/HeartBeatAlertNotification.html.md +22 -0
- data/doc_out/HeartBeatAlertNotificationNotificationUser.html.md +14 -0
- data/doc_out/HeartBeatAlertNotificationNotificationUsers.html.md +14 -0
- data/doc_out/HeartBeatRule.html.md +22 -0
- data/doc_out/HeartBeatRuleContainer.html.md +22 -0
- data/doc_out/HeartBeatRuleNotification.html.md +21 -0
- data/doc_out/HeartBeatRuleNotificationNotificationUser.html.md +14 -0
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRoute.html.md +3 -3
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatAlertNotification.html.md +28 -0
- data/doc_out/InteractionStatAlertNotificationNotificationUser.html.md +14 -0
- data/doc_out/InteractionStatRuleNotification.html.md +26 -0
- data/doc_out/InteractionStatRuleNotificationNotificationUser.html.md +14 -0
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +2 -2
- data/doc_out/Keyword.html.md +4 -1
- data/doc_out/KeywordSet.html.md +1 -1
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/Language.html.md +1 -1
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/Library.html.md +1 -1
- 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/LocationsApi.html.md +4 -4
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/MaxParticipants.html.md +1 -1
- data/doc_out/MetaData.html.md +15 -0
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/OrganizationPresence.html.md +1 -1
- 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/OutOfOfficeNotification.html.md +17 -0
- data/doc_out/OutOfOfficeNotificationUser.html.md +13 -0
- data/doc_out/OutboundApi.html.md +356 -0
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/Participant.html.md +28 -25
- data/doc_out/ParticipantAttributes.html.md +1 -1
- 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/PhonesReboot.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyCreate.html.md +24 -0
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +10 -4
- data/doc_out/QualityApi.html.md +16 -16
- data/doc_out/QualityAudit.html.md +1 -1
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +22 -0
- data/doc_out/RecordingApi.html.md +63 -3
- 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/RoutingApi.html.md +93 -24
- data/doc_out/RoutingSkill.html.md +1 -1
- data/doc_out/RoutingStatus.html.md +3 -3
- 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/ScreenRecordingSession.html.md +3 -0
- data/doc_out/ScreenRecordingSessionListing.html.md +5 -0
- data/doc_out/ScreenRecordingSessionRequest.html.md +15 -0
- data/doc_out/ScreenShareConversationNotification.html.md +16 -0
- data/doc_out/ScreenShareConversationNotificationDetail.html.md +16 -0
- data/doc_out/ScreenShareConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/ScreenShareConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +36 -0
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +36 -0
- data/doc_out/ScreenShareConversationNotificationUriReference.html.md +14 -0
- data/doc_out/Screenshare.html.md +20 -0
- data/doc_out/SearchApi.html.md +26 -26
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/Segment.html.md +5 -5
- data/doc_out/ServiceContext.html.md +1 -1
- 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/SocialConversationNotification.html.md +16 -0
- data/doc_out/SocialConversationNotificationDetail.html.md +16 -0
- data/doc_out/SocialConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/SocialConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/SocialConversationNotificationParticipants.html.md +37 -0
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +37 -0
- data/doc_out/SocialConversationNotificationUriReference.html.md +14 -0
- data/doc_out/SocialExpression.html.md +13 -13
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StreetAddress.html.md +1 -1
- data/doc_out/SubscriberResponse.html.md +2 -2
- data/doc_out/SuggestApi.html.md +14 -14
- data/doc_out/TagValue.html.md +1 -1
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +121 -7
- 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/UserConversationSummaryNotification.html.md +19 -0
- data/doc_out/UserConversationSummaryNotificationCall.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationCallContactCenter.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationMediaSummary.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationMediaSummaryDetail.html.md +14 -0
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserMe.html.md +1 -0
- data/doc_out/UserPresenceNotification.html.md +16 -0
- data/doc_out/UserPresenceNotificationOrganizationPresence.html.md +14 -0
- data/doc_out/UserPresenceNotificationPresenceDefinition.html.md +14 -0
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +6 -6
- data/doc_out/UserRoutingSkillPost.html.md +16 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +14 -14
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/ValidateAddressRequest.html.md +1 -1
- data/doc_out/ValidateAddressResponse.html.md +2 -2
- data/doc_out/Video.html.md +10 -10
- data/doc_out/VideoConversationNotification.html.md +16 -0
- data/doc_out/VideoConversationNotificationDetail.html.md +16 -0
- data/doc_out/VideoConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/VideoConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/VideoConversationNotificationParticipants.html.md +39 -0
- data/doc_out/VideoConversationNotificationUriReference.html.md +14 -0
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +39 -0
- data/doc_out/VmPairingInfo.html.md +16 -0
- data/doc_out/WorkspaceCreate.html.md +1 -1
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/Wrapup.html.md +7 -7
- data/doc_out/WrapupCode.html.md +1 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +6 -6
- data/lib/purecloud.rb +138 -0
- data/lib/purecloud/api/alerting_api.rb +473 -0
- data/lib/purecloud/api/content_management_api.rb +49 -100
- data/lib/purecloud/api/conversations_api.rb +749 -164
- data/lib/purecloud/api/groups_api.rb +126 -4
- data/lib/purecloud/api/locations_api.rb +4 -4
- data/lib/purecloud/api/outbound_api.rb +386 -0
- data/lib/purecloud/api/presence_api.rb +8 -2
- data/lib/purecloud/api/quality_api.rb +14 -14
- data/lib/purecloud/api/recording_api.rb +63 -2
- data/lib/purecloud/api/routing_api.rb +108 -30
- data/lib/purecloud/api/search_api.rb +26 -26
- data/lib/purecloud/api/suggest_api.rb +14 -14
- data/lib/purecloud/api/telephony_providers_edge_api.rb +128 -8
- data/lib/purecloud/api/user_recordings_api.rb +9 -9
- data/lib/purecloud/api/users_api.rb +12 -12
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/acw_settings.rb +2 -0
- data/lib/purecloud/models/address.rb +210 -0
- data/lib/purecloud/models/agent.rb +1 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/analytics_session.rb +1 -1
- data/lib/purecloud/models/attempt_limits.rb +271 -0
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +257 -0
- data/lib/purecloud/models/attribute.rb +1 -0
- data/lib/purecloud/models/attribute_entity_listing.rb +13 -13
- data/lib/purecloud/models/audit_entity.rb +4 -0
- data/lib/purecloud/models/audit_facet.rb +2 -0
- data/lib/purecloud/models/audit_filter.rb +4 -0
- data/lib/purecloud/models/audit_message.rb +14 -0
- data/lib/purecloud/models/audit_search_result.rb +4 -0
- data/lib/purecloud/models/audit_user.rb +3 -0
- data/lib/purecloud/models/available_topic_entity_listing.rb +13 -13
- data/lib/purecloud/models/calibration_create.rb +323 -0
- data/lib/purecloud/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloud/models/call.rb +18 -4
- data/lib/purecloud/models/call_command.rb +1 -0
- data/lib/purecloud/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/call_conversation_notification.rb +218 -0
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +513 -0
- data/lib/purecloud/models/call_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/call_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/call_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/call_conversation_notification_fax_status.rb +235 -0
- data/lib/purecloud/models/call_conversation_notification_participants.rb +513 -0
- data/lib/purecloud/models/call_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/call_media_participant.rb +38 -5
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/callback.rb +17 -5
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/callback_conversation_notification.rb +199 -0
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +456 -0
- data/lib/purecloud/models/callback_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/callback_conversation_notification_dialer_preview.rb +217 -0
- data/lib/purecloud/models/callback_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/callback_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/callback_conversation_notification_error_info_details.rb +195 -0
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +456 -0
- data/lib/purecloud/models/callback_conversation_notification_phone_number_column.rb +185 -0
- data/lib/purecloud/models/callback_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/callback_conversation_notification_user.rb +175 -0
- data/lib/purecloud/models/callback_media_participant.rb +38 -5
- data/lib/purecloud/models/campaign.rb +12 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloud/models/campaign_interaction.rb +388 -0
- data/lib/purecloud/models/campaign_interactions.rb +213 -0
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloud/models/change.rb +3 -0
- data/lib/purecloud/models/channel_entity_listing.rb +13 -13
- data/lib/purecloud/models/channel_topic_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_conversation_notification.rb +199 -0
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +404 -0
- data/lib/purecloud/models/chat_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/chat_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/chat_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +404 -0
- data/lib/purecloud/models/chat_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/chat_media_participant.rb +38 -5
- data/lib/purecloud/models/cobrowse_conversation.rb +213 -0
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +257 -0
- data/lib/purecloud/models/cobrowse_conversation_notification.rb +199 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +446 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +446 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/cobrowse_media_participant.rb +511 -0
- data/lib/purecloud/models/cobrowsesession.rb +296 -0
- data/lib/purecloud/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloud/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/contact_sort.rb +1 -0
- data/lib/purecloud/models/conversation_chat.rb +26 -7
- data/lib/purecloud/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/conversation_notification.rb +207 -0
- data/lib/purecloud/models/conversation_notification_address.rb +215 -0
- data/lib/purecloud/models/conversation_notification_call.rb +383 -0
- data/lib/purecloud/models/conversation_notification_callback.rb +344 -0
- data/lib/purecloud/models/conversation_notification_callbacks.rb +344 -0
- data/lib/purecloud/models/conversation_notification_calls.rb +383 -0
- data/lib/purecloud/models/conversation_notification_chat.rb +263 -0
- data/lib/purecloud/models/conversation_notification_chats.rb +263 -0
- data/lib/purecloud/models/conversation_notification_cobrowse.rb +305 -0
- data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +305 -0
- data/lib/purecloud/models/conversation_notification_dialer_preview.rb +217 -0
- data/lib/purecloud/models/conversation_notification_dialer_preview_phone_number_columns.rb +185 -0
- data/lib/purecloud/models/conversation_notification_disconnect_reason.rb +194 -0
- data/lib/purecloud/models/conversation_notification_disconnect_reasons.rb +194 -0
- data/lib/purecloud/models/conversation_notification_email.rb +283 -0
- data/lib/purecloud/models/conversation_notification_emails.rb +283 -0
- data/lib/purecloud/models/conversation_notification_error_details.rb +237 -0
- data/lib/purecloud/models/conversation_notification_error_info.rb +237 -0
- data/lib/purecloud/models/conversation_notification_fax_status.rb +235 -0
- data/lib/purecloud/models/conversation_notification_participant.rb +443 -0
- data/lib/purecloud/models/conversation_notification_participants.rb +443 -0
- data/lib/purecloud/models/conversation_notification_phone_number_column.rb +185 -0
- data/lib/purecloud/models/conversation_notification_screen_share.rb +263 -0
- data/lib/purecloud/models/conversation_notification_screen_shares.rb +263 -0
- data/lib/purecloud/models/conversation_notification_self.rb +215 -0
- data/lib/purecloud/models/conversation_notification_social_expression.rb +303 -0
- data/lib/purecloud/models/conversation_notification_social_expressions.rb +303 -0
- data/lib/purecloud/models/conversation_notification_video.rb +302 -0
- data/lib/purecloud/models/conversation_notification_videos.rb +302 -0
- data/lib/purecloud/models/conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/create_callback_command.rb +1 -1
- data/lib/purecloud/models/create_share_request.rb +3 -0
- data/lib/purecloud/models/dialer_audit_request.rb +4 -0
- data/lib/purecloud/models/dialer_contact.rb +1 -1
- data/lib/purecloud/models/dialer_preview.rb +4 -0
- data/lib/purecloud/models/did_entity_listing.rb +13 -13
- data/lib/purecloud/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/disconnect_reason.rb +3 -0
- data/lib/purecloud/models/dnc_list.rb +2 -14
- data/lib/purecloud/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_update.rb +1 -0
- data/lib/purecloud/models/document_upload.rb +2 -0
- data/lib/purecloud/models/domain_capabilities.rb +33 -4
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +13 -13
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +257 -0
- data/lib/purecloud/models/domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloud/models/domain_logical_interface.rb +25 -41
- data/lib/purecloud/models/domain_network_address.rb +22 -0
- data/lib/purecloud/models/domain_network_route.rb +14 -0
- data/lib/purecloud/models/domain_organization_role_create.rb +266 -0
- data/lib/purecloud/models/edge.rb +21 -1
- data/lib/purecloud/models/edge_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_logs_job_request.rb +3 -0
- data/lib/purecloud/models/edge_logs_job_upload_request.rb +1 -1
- data/lib/purecloud/models/edge_offline_configuration.rb +177 -0
- data/lib/purecloud/models/edge_offline_configuration_interface.rb +203 -0
- data/lib/purecloud/models/edge_offline_configuration_network.rb +166 -0
- data/lib/purecloud/models/edge_offline_configuration_response.rb +166 -0
- data/lib/purecloud/models/email.rb +28 -8
- data/lib/purecloud/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/email_conversation_notification.rb +199 -0
- data/lib/purecloud/models/email_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +414 -0
- data/lib/purecloud/models/email_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/email_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/email_conversation_notification_participants.rb +414 -0
- data/lib/purecloud/models/email_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/email_media_participant.rb +38 -5
- data/lib/purecloud/models/email_message_listing.rb +13 -13
- data/lib/purecloud/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloud/models/endpoint_entity_listing.rb +13 -13
- data/lib/purecloud/models/entry.rb +2 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluation_form.rb +3 -0
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/extension_entity_listing.rb +13 -13
- data/lib/purecloud/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/facet_info.rb +2 -0
- data/lib/purecloud/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloud/models/fax_status.rb +8 -0
- data/lib/purecloud/models/group.rb +1 -0
- data/lib/purecloud/models/group_entity_listing.rb +13 -13
- data/lib/purecloud/models/group_members_update.rb +2 -0
- data/lib/purecloud/models/group_update.rb +286 -0
- data/lib/purecloud/models/heart_beat_alert.rb +299 -0
- data/lib/purecloud/models/heart_beat_alert_container.rb +257 -0
- data/lib/purecloud/models/heart_beat_alert_notification.rb +268 -0
- data/lib/purecloud/models/heart_beat_alert_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/heart_beat_alert_notification_notification_users.rb +175 -0
- data/lib/purecloud/models/heart_beat_rule.rb +282 -0
- data/lib/purecloud/models/heart_beat_rule_container.rb +257 -0
- data/lib/purecloud/models/heart_beat_rule_notification.rb +258 -0
- data/lib/purecloud/models/heart_beat_rule_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/interaction_stat_alert_notification.rb +364 -0
- data/lib/purecloud/models/interaction_stat_alert_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/interaction_stat_rule_notification.rb +344 -0
- data/lib/purecloud/models/interaction_stat_rule_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloud/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloud/models/json_node.rb +20 -20
- data/lib/purecloud/models/keyword.rb +41 -1
- data/lib/purecloud/models/keyword_set.rb +1 -0
- data/lib/purecloud/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/language.rb +1 -0
- data/lib/purecloud/models/language_entity_listing.rb +13 -13
- data/lib/purecloud/models/library.rb +1 -0
- data/lib/purecloud/models/library_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_entity_listing.rb +13 -13
- data/lib/purecloud/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/max_participants.rb +1 -0
- data/lib/purecloud/models/meta_data.rb +187 -0
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloud/models/organization_presence.rb +1 -0
- data/lib/purecloud/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloud/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloud/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloud/models/out_of_office_notification.rb +205 -0
- data/lib/purecloud/models/out_of_office_notification_user.rb +165 -0
- data/lib/purecloud/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/participant.rb +61 -4
- data/lib/purecloud/models/participant_attributes.rb +1 -0
- data/lib/purecloud/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phones_reboot.rb +2 -0
- data/lib/purecloud/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/policy_create.rb +285 -0
- data/lib/purecloud/models/policy_entity_listing.rb +13 -13
- data/lib/purecloud/models/quality_audit.rb +11 -11
- data/lib/purecloud/models/quality_audit_page.rb +13 -13
- data/lib/purecloud/models/queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/queue_member_entity_listing.rb +257 -0
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloud/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_entity_list.rb +13 -13
- data/lib/purecloud/models/response_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/routing_skill.rb +1 -0
- data/lib/purecloud/models/routing_status.rb +3 -1
- data/lib/purecloud/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloud/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloud/models/screen_recording_session.rb +36 -4
- data/lib/purecloud/models/screen_recording_session_listing.rb +51 -1
- data/lib/purecloud/models/screen_recording_session_request.rb +197 -0
- data/lib/purecloud/models/screen_share_conversation_notification.rb +199 -0
- data/lib/purecloud/models/screen_share_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/screen_share_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/screen_share_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +424 -0
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +424 -0
- data/lib/purecloud/models/screen_share_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/screenshare.rb +263 -0
- data/lib/purecloud/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloud/models/segment.rb +5 -2
- data/lib/purecloud/models/service_context.rb +1 -0
- data/lib/purecloud/models/share_entity_listing.rb +13 -13
- data/lib/purecloud/models/site.rb +1 -1
- data/lib/purecloud/models/site_entity_listing.rb +13 -13
- data/lib/purecloud/models/skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/social_conversation_notification.rb +199 -0
- data/lib/purecloud/models/social_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/social_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/social_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/social_conversation_notification_participants.rb +434 -0
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +434 -0
- data/lib/purecloud/models/social_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/social_expression.rb +14 -4
- data/lib/purecloud/models/station_entity_listing.rb +13 -13
- data/lib/purecloud/models/street_address.rb +1 -0
- data/lib/purecloud/models/subscriber_response.rb +2 -0
- data/lib/purecloud/models/tag_value.rb +1 -0
- data/lib/purecloud/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloud/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_conversation_summary_notification.rb +225 -0
- data/lib/purecloud/models/user_conversation_summary_notification_call.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_call_contact_center.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_media_summary.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_media_summary_detail.rb +175 -0
- data/lib/purecloud/models/user_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_me.rb +14 -1
- data/lib/purecloud/models/user_presence_notification.rb +195 -0
- data/lib/purecloud/models/user_presence_notification_organization_presence.rb +175 -0
- data/lib/purecloud/models/user_presence_notification_presence_definition.rb +175 -0
- data/lib/purecloud/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_routing_skill_post.rb +200 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/users_entity_listing.rb +13 -13
- data/lib/purecloud/models/validate_address_request.rb +1 -1
- data/lib/purecloud/models/validate_address_response.rb +2 -0
- data/lib/purecloud/models/video.rb +11 -3
- data/lib/purecloud/models/video_conversation_notification.rb +199 -0
- data/lib/purecloud/models/video_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/video_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/video_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/video_conversation_notification_participants.rb +463 -0
- data/lib/purecloud/models/video_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +463 -0
- data/lib/purecloud/models/vm_pairing_info.rb +196 -0
- data/lib/purecloud/models/workspace_create.rb +1 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloud/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloud/models/wrapup.rb +7 -1
- data/lib/purecloud/models/wrapup_code.rb +1 -0
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +279 -2
@@ -399,7 +399,7 @@ module PureCloud
|
|
399
399
|
# @param workspace_id Workspace ID
|
400
400
|
# @param [Hash] opts the optional parameters
|
401
401
|
# @option opts [String] :name Name
|
402
|
-
# @option opts [String] :expand
|
402
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
403
403
|
# @option opts [Integer] :page_size Page size (default to 25)
|
404
404
|
# @option opts [Integer] :page_number Page number (default to 1)
|
405
405
|
# @option opts [String] :sort_by name or dateCreated
|
@@ -415,7 +415,7 @@ module PureCloud
|
|
415
415
|
# @param workspace_id Workspace ID
|
416
416
|
# @param [Hash] opts the optional parameters
|
417
417
|
# @option opts [String] :name Name
|
418
|
-
# @option opts [String] :expand
|
418
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
419
419
|
# @option opts [Integer] :page_size Page size
|
420
420
|
# @option opts [Integer] :page_number Page number
|
421
421
|
# @option opts [String] :sort_by name or dateCreated
|
@@ -429,10 +429,6 @@ module PureCloud
|
|
429
429
|
# verify the required parameter 'workspace_id' is set
|
430
430
|
fail "Missing the required parameter 'workspace_id' when calling get_documents" if workspace_id.nil?
|
431
431
|
|
432
|
-
if opts[:'expand'] && !['acl', 'workspace'].include?(opts[:'expand'])
|
433
|
-
fail 'invalid value for "expand", must be one of acl, workspace'
|
434
|
-
end
|
435
|
-
|
436
432
|
# resource path
|
437
433
|
local_var_path = "/api/v2/contentmanagement/documents".sub('{format}','json')
|
438
434
|
|
@@ -440,7 +436,7 @@ module PureCloud
|
|
440
436
|
query_params = {}
|
441
437
|
query_params[:'workspaceId'] = workspace_id
|
442
438
|
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
443
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
439
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
444
440
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
445
441
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
446
442
|
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
@@ -481,7 +477,7 @@ module PureCloud
|
|
481
477
|
#
|
482
478
|
# @param document_id Document ID
|
483
479
|
# @param [Hash] opts the optional parameters
|
484
|
-
# @option opts [String] :expand
|
480
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
485
481
|
# @return [Document]
|
486
482
|
def get_documents_document_id(document_id, opts = {})
|
487
483
|
data, status_code, headers = get_documents_document_id_with_http_info(document_id, opts)
|
@@ -492,7 +488,7 @@ module PureCloud
|
|
492
488
|
#
|
493
489
|
# @param document_id Document ID
|
494
490
|
# @param [Hash] opts the optional parameters
|
495
|
-
# @option opts [String] :expand
|
491
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
496
492
|
# @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
|
497
493
|
def get_documents_document_id_with_http_info(document_id, opts = {})
|
498
494
|
if @api_client.config.debugging
|
@@ -502,16 +498,12 @@ module PureCloud
|
|
502
498
|
# verify the required parameter 'document_id' is set
|
503
499
|
fail "Missing the required parameter 'document_id' when calling get_documents_document_id" if document_id.nil?
|
504
500
|
|
505
|
-
if opts[:'expand'] && !['lockInfo', 'acl', 'workspace'].include?(opts[:'expand'])
|
506
|
-
fail 'invalid value for "expand", must be one of lockInfo, acl, workspace'
|
507
|
-
end
|
508
|
-
|
509
501
|
# resource path
|
510
502
|
local_var_path = "/api/v2/contentmanagement/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
|
511
503
|
|
512
504
|
# query parameters
|
513
505
|
query_params = {}
|
514
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
506
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
515
507
|
|
516
508
|
# header parameters
|
517
509
|
header_params = {}
|
@@ -626,21 +618,21 @@ module PureCloud
|
|
626
618
|
#
|
627
619
|
# @param document_id Document ID
|
628
620
|
# @param [Hash] opts the optional parameters
|
629
|
-
# @option opts [String] :disposition Request how the content will be downloaded:
|
621
|
+
# @option opts [String] :disposition Request how the content will be downloaded: a file attachment or inline. Default is attachment.
|
630
622
|
# @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
|
631
|
-
# @return [
|
623
|
+
# @return [DownloadResponse]
|
632
624
|
def get_documents_document_id_content(document_id, opts = {})
|
633
|
-
get_documents_document_id_content_with_http_info(document_id, opts)
|
634
|
-
return
|
625
|
+
data, status_code, headers = get_documents_document_id_content_with_http_info(document_id, opts)
|
626
|
+
return data
|
635
627
|
end
|
636
628
|
|
637
629
|
# Download a document.
|
638
630
|
#
|
639
631
|
# @param document_id Document ID
|
640
632
|
# @param [Hash] opts the optional parameters
|
641
|
-
# @option opts [String] :disposition Request how the content will be downloaded:
|
633
|
+
# @option opts [String] :disposition Request how the content will be downloaded: a file attachment or inline. Default is attachment.
|
642
634
|
# @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
|
643
|
-
# @return [Array<(
|
635
|
+
# @return [Array<(DownloadResponse, Fixnum, Hash)>] DownloadResponse data, response status code and response headers
|
644
636
|
def get_documents_document_id_content_with_http_info(document_id, opts = {})
|
645
637
|
if @api_client.config.debugging
|
646
638
|
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_documents_document_id_content ..."
|
@@ -684,7 +676,8 @@ module PureCloud
|
|
684
676
|
:query_params => query_params,
|
685
677
|
:form_params => form_params,
|
686
678
|
:body => post_body,
|
687
|
-
:auth_names => auth_names
|
679
|
+
:auth_names => auth_names,
|
680
|
+
:return_type => 'DownloadResponse')
|
688
681
|
if @api_client.config.debugging
|
689
682
|
@api_client.config.logger.debug "API called: ContentManagementApi#get_documents_document_id_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
690
683
|
end
|
@@ -699,7 +692,7 @@ module PureCloud
|
|
699
692
|
# @option opts [Integer] :page_number Page number (default to 1)
|
700
693
|
# @option opts [String] :sort_by name or dateCreated (default to name)
|
701
694
|
# @option opts [String] :sort_order ascending or descending (default to ascending)
|
702
|
-
# @option opts [String] :expand
|
695
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
703
696
|
# @return [QueryResults]
|
704
697
|
def get_query(query_phrase, opts = {})
|
705
698
|
data, status_code, headers = get_query_with_http_info(query_phrase, opts)
|
@@ -714,7 +707,7 @@ module PureCloud
|
|
714
707
|
# @option opts [Integer] :page_number Page number
|
715
708
|
# @option opts [String] :sort_by name or dateCreated
|
716
709
|
# @option opts [String] :sort_order ascending or descending
|
717
|
-
# @option opts [String] :expand
|
710
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
718
711
|
# @return [Array<(QueryResults, Fixnum, Hash)>] QueryResults data, response status code and response headers
|
719
712
|
def get_query_with_http_info(query_phrase, opts = {})
|
720
713
|
if @api_client.config.debugging
|
@@ -724,10 +717,6 @@ module PureCloud
|
|
724
717
|
# verify the required parameter 'query_phrase' is set
|
725
718
|
fail "Missing the required parameter 'query_phrase' when calling get_query" if query_phrase.nil?
|
726
719
|
|
727
|
-
if opts[:'expand'] && !['acl', 'workspace'].include?(opts[:'expand'])
|
728
|
-
fail 'invalid value for "expand", must be one of acl, workspace'
|
729
|
-
end
|
730
|
-
|
731
720
|
# resource path
|
732
721
|
local_var_path = "/api/v2/contentmanagement/query".sub('{format}','json')
|
733
722
|
|
@@ -738,7 +727,7 @@ module PureCloud
|
|
738
727
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
739
728
|
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
740
729
|
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
741
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
730
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
742
731
|
|
743
732
|
# header parameters
|
744
733
|
header_params = {}
|
@@ -969,7 +958,7 @@ module PureCloud
|
|
969
958
|
# Failing to specify a filter will return 400.
|
970
959
|
# @param [Hash] opts the optional parameters
|
971
960
|
# @option opts [String] :entity_id Filters the shares returned to only the entity specified by the value of this parameter.
|
972
|
-
# @option opts [String] :expand
|
961
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
973
962
|
# @option opts [Integer] :page_size Page size (default to 25)
|
974
963
|
# @option opts [Integer] :page_number Page number (default to 1)
|
975
964
|
# @return [ShareEntityListing]
|
@@ -982,7 +971,7 @@ module PureCloud
|
|
982
971
|
# Failing to specify a filter will return 400.
|
983
972
|
# @param [Hash] opts the optional parameters
|
984
973
|
# @option opts [String] :entity_id Filters the shares returned to only the entity specified by the value of this parameter.
|
985
|
-
# @option opts [String] :expand
|
974
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
986
975
|
# @option opts [Integer] :page_size Page size
|
987
976
|
# @option opts [Integer] :page_number Page number
|
988
977
|
# @return [Array<(ShareEntityListing, Fixnum, Hash)>] ShareEntityListing data, response status code and response headers
|
@@ -991,17 +980,13 @@ module PureCloud
|
|
991
980
|
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_shares ..."
|
992
981
|
end
|
993
982
|
|
994
|
-
if opts[:'expand'] && !['member'].include?(opts[:'expand'])
|
995
|
-
fail 'invalid value for "expand", must be one of member'
|
996
|
-
end
|
997
|
-
|
998
983
|
# resource path
|
999
984
|
local_var_path = "/api/v2/contentmanagement/shares".sub('{format}','json')
|
1000
985
|
|
1001
986
|
# query parameters
|
1002
987
|
query_params = {}
|
1003
988
|
query_params[:'entityId'] = opts[:'entity_id'] if opts[:'entity_id']
|
1004
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
989
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1005
990
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
1006
991
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1007
992
|
|
@@ -1040,7 +1025,7 @@ module PureCloud
|
|
1040
1025
|
#
|
1041
1026
|
# @param share_id Share ID
|
1042
1027
|
# @param [Hash] opts the optional parameters
|
1043
|
-
# @option opts [String] :expand
|
1028
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1044
1029
|
# @return [Share]
|
1045
1030
|
def get_shares_share_id(share_id, opts = {})
|
1046
1031
|
data, status_code, headers = get_shares_share_id_with_http_info(share_id, opts)
|
@@ -1051,7 +1036,7 @@ module PureCloud
|
|
1051
1036
|
#
|
1052
1037
|
# @param share_id Share ID
|
1053
1038
|
# @param [Hash] opts the optional parameters
|
1054
|
-
# @option opts [String] :expand
|
1039
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1055
1040
|
# @return [Array<(Share, Fixnum, Hash)>] Share data, response status code and response headers
|
1056
1041
|
def get_shares_share_id_with_http_info(share_id, opts = {})
|
1057
1042
|
if @api_client.config.debugging
|
@@ -1061,16 +1046,12 @@ module PureCloud
|
|
1061
1046
|
# verify the required parameter 'share_id' is set
|
1062
1047
|
fail "Missing the required parameter 'share_id' when calling get_shares_share_id" if share_id.nil?
|
1063
1048
|
|
1064
|
-
if opts[:'expand'] && !['member'].include?(opts[:'expand'])
|
1065
|
-
fail 'invalid value for "expand", must be one of member'
|
1066
|
-
end
|
1067
|
-
|
1068
1049
|
# resource path
|
1069
1050
|
local_var_path = "/api/v2/contentmanagement/shares/{shareId}".sub('{format}','json').sub('{' + 'shareId' + '}', share_id.to_s)
|
1070
1051
|
|
1071
1052
|
# query parameters
|
1072
1053
|
query_params = {}
|
1073
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
1054
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1074
1055
|
|
1075
1056
|
# header parameters
|
1076
1057
|
header_params = {}
|
@@ -1284,8 +1265,8 @@ module PureCloud
|
|
1284
1265
|
# @param [Hash] opts the optional parameters
|
1285
1266
|
# @option opts [Integer] :page_size Page size (default to 25)
|
1286
1267
|
# @option opts [Integer] :page_number Page number (default to 1)
|
1287
|
-
# @option opts [String] :access Requested access level
|
1288
|
-
# @option opts [String] :expand
|
1268
|
+
# @option opts [Array<String>] :access Requested access level.
|
1269
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1289
1270
|
# @return [WorkspaceEntityListing]
|
1290
1271
|
def get_workspaces(opts = {})
|
1291
1272
|
data, status_code, headers = get_workspaces_with_http_info(opts)
|
@@ -1297,22 +1278,14 @@ module PureCloud
|
|
1297
1278
|
# @param [Hash] opts the optional parameters
|
1298
1279
|
# @option opts [Integer] :page_size Page size
|
1299
1280
|
# @option opts [Integer] :page_number Page number
|
1300
|
-
# @option opts [String] :access Requested access level
|
1301
|
-
# @option opts [String] :expand
|
1281
|
+
# @option opts [Array<String>] :access Requested access level.
|
1282
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1302
1283
|
# @return [Array<(WorkspaceEntityListing, Fixnum, Hash)>] WorkspaceEntityListing data, response status code and response headers
|
1303
1284
|
def get_workspaces_with_http_info(opts = {})
|
1304
1285
|
if @api_client.config.debugging
|
1305
1286
|
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces ..."
|
1306
1287
|
end
|
1307
1288
|
|
1308
|
-
if opts[:'access'] && !['content', 'admin', 'document:create', 'document:viewContent', 'document:viewMetadata', 'document:download', 'document:delete', 'document:update', 'document:share', 'document:shareView', 'document:email', 'document:print', 'document:auditView', 'document:replace', 'document:tag', 'tag:create', 'tag:view', 'tag:update', 'tag:apply', 'tag:remove', 'tag:delete'].include?(opts[:'access'])
|
1309
|
-
fail 'invalid value for "access", must be one of content, admin, document:create, document:viewContent, document:viewMetadata, document:download, document:delete, document:update, document:share, document:shareView, document:email, document:print, document:auditView, document:replace, document:tag, tag:create, tag:view, tag:update, tag:apply, tag:remove, tag:delete'
|
1310
|
-
end
|
1311
|
-
|
1312
|
-
if opts[:'expand'] && !['summary', 'acl'].include?(opts[:'expand'])
|
1313
|
-
fail 'invalid value for "expand", must be one of summary, acl'
|
1314
|
-
end
|
1315
|
-
|
1316
1289
|
# resource path
|
1317
1290
|
local_var_path = "/api/v2/contentmanagement/workspaces".sub('{format}','json')
|
1318
1291
|
|
@@ -1320,8 +1293,8 @@ module PureCloud
|
|
1320
1293
|
query_params = {}
|
1321
1294
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
1322
1295
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1323
|
-
query_params[:'access'] = opts[:'access'] if opts[:'access']
|
1324
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
1296
|
+
query_params[:'access'] = @api_client.build_collection_param(opts[:'access'], :multi) if opts[:'access']
|
1297
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1325
1298
|
|
1326
1299
|
# header parameters
|
1327
1300
|
header_params = {}
|
@@ -1358,7 +1331,7 @@ module PureCloud
|
|
1358
1331
|
#
|
1359
1332
|
# @param workspace_id Workspace ID
|
1360
1333
|
# @param [Hash] opts the optional parameters
|
1361
|
-
# @option opts [String] :expand
|
1334
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1362
1335
|
# @return [Workspace]
|
1363
1336
|
def get_workspaces_workspace_id(workspace_id, opts = {})
|
1364
1337
|
data, status_code, headers = get_workspaces_workspace_id_with_http_info(workspace_id, opts)
|
@@ -1369,7 +1342,7 @@ module PureCloud
|
|
1369
1342
|
#
|
1370
1343
|
# @param workspace_id Workspace ID
|
1371
1344
|
# @param [Hash] opts the optional parameters
|
1372
|
-
# @option opts [String] :expand
|
1345
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1373
1346
|
# @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
|
1374
1347
|
def get_workspaces_workspace_id_with_http_info(workspace_id, opts = {})
|
1375
1348
|
if @api_client.config.debugging
|
@@ -1379,16 +1352,12 @@ module PureCloud
|
|
1379
1352
|
# verify the required parameter 'workspace_id' is set
|
1380
1353
|
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id" if workspace_id.nil?
|
1381
1354
|
|
1382
|
-
if opts[:'expand'] && !['summary', 'acl'].include?(opts[:'expand'])
|
1383
|
-
fail 'invalid value for "expand", must be one of summary, acl'
|
1384
|
-
end
|
1385
|
-
|
1386
1355
|
# resource path
|
1387
1356
|
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
1388
1357
|
|
1389
1358
|
# query parameters
|
1390
1359
|
query_params = {}
|
1391
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
1360
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1392
1361
|
|
1393
1362
|
# header parameters
|
1394
1363
|
header_params = {}
|
@@ -1427,7 +1396,7 @@ module PureCloud
|
|
1427
1396
|
# @param [Hash] opts the optional parameters
|
1428
1397
|
# @option opts [Integer] :page_size Page size (default to 25)
|
1429
1398
|
# @option opts [Integer] :page_number Page number (default to 1)
|
1430
|
-
# @option opts [String] :expand
|
1399
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1431
1400
|
# @return [WorkspaceMemberEntityListing]
|
1432
1401
|
def get_workspaces_workspace_id_members(workspace_id, opts = {})
|
1433
1402
|
data, status_code, headers = get_workspaces_workspace_id_members_with_http_info(workspace_id, opts)
|
@@ -1440,7 +1409,7 @@ module PureCloud
|
|
1440
1409
|
# @param [Hash] opts the optional parameters
|
1441
1410
|
# @option opts [Integer] :page_size Page size
|
1442
1411
|
# @option opts [Integer] :page_number Page number
|
1443
|
-
# @option opts [String] :expand
|
1412
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1444
1413
|
# @return [Array<(WorkspaceMemberEntityListing, Fixnum, Hash)>] WorkspaceMemberEntityListing data, response status code and response headers
|
1445
1414
|
def get_workspaces_workspace_id_members_with_http_info(workspace_id, opts = {})
|
1446
1415
|
if @api_client.config.debugging
|
@@ -1450,10 +1419,6 @@ module PureCloud
|
|
1450
1419
|
# verify the required parameter 'workspace_id' is set
|
1451
1420
|
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id_members" if workspace_id.nil?
|
1452
1421
|
|
1453
|
-
if opts[:'expand'] && !['member'].include?(opts[:'expand'])
|
1454
|
-
fail 'invalid value for "expand", must be one of member'
|
1455
|
-
end
|
1456
|
-
|
1457
1422
|
# resource path
|
1458
1423
|
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/members".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
1459
1424
|
|
@@ -1461,7 +1426,7 @@ module PureCloud
|
|
1461
1426
|
query_params = {}
|
1462
1427
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
1463
1428
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1464
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
1429
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1465
1430
|
|
1466
1431
|
# header parameters
|
1467
1432
|
header_params = {}
|
@@ -1499,7 +1464,7 @@ module PureCloud
|
|
1499
1464
|
# @param workspace_id Workspace ID
|
1500
1465
|
# @param member_id Member ID
|
1501
1466
|
# @param [Hash] opts the optional parameters
|
1502
|
-
# @option opts [String] :expand
|
1467
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1503
1468
|
# @return [WorkspaceMember]
|
1504
1469
|
def get_workspaces_workspace_id_members_member_id(workspace_id, member_id, opts = {})
|
1505
1470
|
data, status_code, headers = get_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts)
|
@@ -1511,7 +1476,7 @@ module PureCloud
|
|
1511
1476
|
# @param workspace_id Workspace ID
|
1512
1477
|
# @param member_id Member ID
|
1513
1478
|
# @param [Hash] opts the optional parameters
|
1514
|
-
# @option opts [String] :expand
|
1479
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1515
1480
|
# @return [Array<(WorkspaceMember, Fixnum, Hash)>] WorkspaceMember data, response status code and response headers
|
1516
1481
|
def get_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, opts = {})
|
1517
1482
|
if @api_client.config.debugging
|
@@ -1524,16 +1489,12 @@ module PureCloud
|
|
1524
1489
|
# verify the required parameter 'member_id' is set
|
1525
1490
|
fail "Missing the required parameter 'member_id' when calling get_workspaces_workspace_id_members_member_id" if member_id.nil?
|
1526
1491
|
|
1527
|
-
if opts[:'expand'] && !['member'].include?(opts[:'expand'])
|
1528
|
-
fail 'invalid value for "expand", must be one of member'
|
1529
|
-
end
|
1530
|
-
|
1531
1492
|
# resource path
|
1532
1493
|
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
|
1533
1494
|
|
1534
1495
|
# query parameters
|
1535
1496
|
query_params = {}
|
1536
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
1497
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1537
1498
|
|
1538
1499
|
# header parameters
|
1539
1500
|
header_params = {}
|
@@ -1573,7 +1534,7 @@ module PureCloud
|
|
1573
1534
|
# @option opts [String] :value filter the list of tags returned
|
1574
1535
|
# @option opts [Integer] :page_size Page size (default to 25)
|
1575
1536
|
# @option opts [Integer] :page_number Page number (default to 1)
|
1576
|
-
# @option opts [String] :expand
|
1537
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1577
1538
|
# @return [TagValueEntityListing]
|
1578
1539
|
def get_workspaces_workspace_id_tagvalues(workspace_id, opts = {})
|
1579
1540
|
data, status_code, headers = get_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts)
|
@@ -1587,7 +1548,7 @@ module PureCloud
|
|
1587
1548
|
# @option opts [String] :value filter the list of tags returned
|
1588
1549
|
# @option opts [Integer] :page_size Page size
|
1589
1550
|
# @option opts [Integer] :page_number Page number
|
1590
|
-
# @option opts [String] :expand
|
1551
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1591
1552
|
# @return [Array<(TagValueEntityListing, Fixnum, Hash)>] TagValueEntityListing data, response status code and response headers
|
1592
1553
|
def get_workspaces_workspace_id_tagvalues_with_http_info(workspace_id, opts = {})
|
1593
1554
|
if @api_client.config.debugging
|
@@ -1597,10 +1558,6 @@ module PureCloud
|
|
1597
1558
|
# verify the required parameter 'workspace_id' is set
|
1598
1559
|
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id_tagvalues" if workspace_id.nil?
|
1599
1560
|
|
1600
|
-
if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
|
1601
|
-
fail 'invalid value for "expand", must be one of acl'
|
1602
|
-
end
|
1603
|
-
|
1604
1561
|
# resource path
|
1605
1562
|
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
1606
1563
|
|
@@ -1609,7 +1566,7 @@ module PureCloud
|
|
1609
1566
|
query_params[:'value'] = opts[:'value'] if opts[:'value']
|
1610
1567
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
1611
1568
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1612
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
1569
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1613
1570
|
|
1614
1571
|
# header parameters
|
1615
1572
|
header_params = {}
|
@@ -1647,7 +1604,7 @@ module PureCloud
|
|
1647
1604
|
# @param workspace_id Workspace ID
|
1648
1605
|
# @param tag_id Tag ID
|
1649
1606
|
# @param [Hash] opts the optional parameters
|
1650
|
-
# @option opts [String] :expand
|
1607
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1651
1608
|
# @return [TagValue]
|
1652
1609
|
def get_workspaces_workspace_id_tagvalues_tag_id(workspace_id, tag_id, opts = {})
|
1653
1610
|
data, status_code, headers = get_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts)
|
@@ -1659,7 +1616,7 @@ module PureCloud
|
|
1659
1616
|
# @param workspace_id Workspace ID
|
1660
1617
|
# @param tag_id Tag ID
|
1661
1618
|
# @param [Hash] opts the optional parameters
|
1662
|
-
# @option opts [String] :expand
|
1619
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
1663
1620
|
# @return [Array<(TagValue, Fixnum, Hash)>] TagValue data, response status code and response headers
|
1664
1621
|
def get_workspaces_workspace_id_tagvalues_tag_id_with_http_info(workspace_id, tag_id, opts = {})
|
1665
1622
|
if @api_client.config.debugging
|
@@ -1672,16 +1629,12 @@ module PureCloud
|
|
1672
1629
|
# verify the required parameter 'tag_id' is set
|
1673
1630
|
fail "Missing the required parameter 'tag_id' when calling get_workspaces_workspace_id_tagvalues_tag_id" if tag_id.nil?
|
1674
1631
|
|
1675
|
-
if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
|
1676
|
-
fail 'invalid value for "expand", must be one of acl'
|
1677
|
-
end
|
1678
|
-
|
1679
1632
|
# resource path
|
1680
1633
|
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)
|
1681
1634
|
|
1682
1635
|
# query parameters
|
1683
1636
|
query_params = {}
|
1684
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
1637
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1685
1638
|
|
1686
1639
|
# header parameters
|
1687
1640
|
header_params = {}
|
@@ -2243,7 +2196,7 @@ module PureCloud
|
|
2243
2196
|
# @param workspace_id Workspace ID
|
2244
2197
|
# @param body query
|
2245
2198
|
# @param [Hash] opts the optional parameters
|
2246
|
-
# @option opts [String] :expand
|
2199
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
2247
2200
|
# @return [TagValueEntityListing]
|
2248
2201
|
def post_workspaces_workspace_id_tagvalues_query(workspace_id, body, opts = {})
|
2249
2202
|
data, status_code, headers = post_workspaces_workspace_id_tagvalues_query_with_http_info(workspace_id, body, opts)
|
@@ -2255,7 +2208,7 @@ module PureCloud
|
|
2255
2208
|
# @param workspace_id Workspace ID
|
2256
2209
|
# @param body query
|
2257
2210
|
# @param [Hash] opts the optional parameters
|
2258
|
-
# @option opts [String] :expand
|
2211
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
2259
2212
|
# @return [Array<(TagValueEntityListing, Fixnum, Hash)>] TagValueEntityListing data, response status code and response headers
|
2260
2213
|
def post_workspaces_workspace_id_tagvalues_query_with_http_info(workspace_id, body, opts = {})
|
2261
2214
|
if @api_client.config.debugging
|
@@ -2268,16 +2221,12 @@ module PureCloud
|
|
2268
2221
|
# verify the required parameter 'body' is set
|
2269
2222
|
fail "Missing the required parameter 'body' when calling post_workspaces_workspace_id_tagvalues_query" if body.nil?
|
2270
2223
|
|
2271
|
-
if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
|
2272
|
-
fail 'invalid value for "expand", must be one of acl'
|
2273
|
-
end
|
2274
|
-
|
2275
2224
|
# resource path
|
2276
2225
|
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
2277
2226
|
|
2278
2227
|
# query parameters
|
2279
2228
|
query_params = {}
|
2280
|
-
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
2229
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
2281
2230
|
|
2282
2231
|
# header parameters
|
2283
2232
|
header_params = {}
|
@@ -2379,7 +2328,7 @@ module PureCloud
|
|
2379
2328
|
#
|
2380
2329
|
# @param workspace_id Workspace ID
|
2381
2330
|
# @param member_id Member ID
|
2382
|
-
# @param body Workspace
|
2331
|
+
# @param body Workspace Member
|
2383
2332
|
# @param [Hash] opts the optional parameters
|
2384
2333
|
# @return [WorkspaceMember]
|
2385
2334
|
def put_workspaces_workspace_id_members_member_id(workspace_id, member_id, body, opts = {})
|
@@ -2391,7 +2340,7 @@ module PureCloud
|
|
2391
2340
|
#
|
2392
2341
|
# @param workspace_id Workspace ID
|
2393
2342
|
# @param member_id Member ID
|
2394
|
-
# @param body Workspace
|
2343
|
+
# @param body Workspace Member
|
2395
2344
|
# @param [Hash] opts the optional parameters
|
2396
2345
|
# @return [Array<(WorkspaceMember, Fixnum, Hash)>] WorkspaceMember data, response status code and response headers
|
2397
2346
|
def put_workspaces_workspace_id_members_member_id_with_http_info(workspace_id, member_id, body, opts = {})
|