kaltura-client 15.20.0 → 16.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fe21f9c1c398cb40a83d57bac471e0d02bf746808ed6039988412533fa18273
-  data.tar.gz: 47cec5f1324c478dea7a54e2af4f687c2eacf50600b292a3ee6894bbf6516038
+  metadata.gz: 9ce7ad2c1ba3b0fbce5a83b65cf61c50391dd211265efbec4d7cf01456908283
+  data.tar.gz: fbdd2afb79433ee1eff09bd9a501aff19a44f886e118fd821ddf39aa42e88cbb
 SHA512:
-  metadata.gz: e51efccb3749c5e23169419f7e7f46b94a674efde6d59cfe00f9b808ea2d897877e2459e981ad70945fdde34cffa564e9196f4ada8fc5d15e93efb3d72bdfac7
-  data.tar.gz: 259230a283b5782fbdf933d7926073e6b673c36ec2b9ace7415e8b8450153a9db21b7ca9c6c5da01e1a722fdc852619d5a414284fccb544c5e23225d684f6c14
+  metadata.gz: 61fd5f35db2ff11daffc2361af4b89444966b29f91351560a260d27e135824e7ff01716283355df3b67071ce738fdb82c50fcd0fd900e0312bc5f37b9b993b0a
+  data.tar.gz: 23742d7ec237aa96a8220feea82ec02834598dd7041f3a07d7c95d124de53e3d907aa41cb02fc0a71062ff04b093f0d53baa66c7e77c798a9fa3a0c032fb61d3

data/README

@@ -1,5 +1,5 @@
 Kaltura Ruby API Client Library.
-Compatible with Kaltura server version 15.20.0 and above.
+Compatible with Kaltura server version 16.8.0 and above.
 
 This source contains:
  - The Kaltura client library (kaltura_client_base.rb)

data/lib/kaltura_client.rb

@@ -2479,6 +2479,19 @@ module Kaltura
 			return client.do_queue()
 		end
 
+		# Allocates a conference room or returns ones that has already been allocated
+		# @return [KalturaRoomDetails]
+		def allocate_conference_room(entry_id, env='')
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'env', env)
+			client.queue_service_action_call('livestream', 'allocateConferenceRoom', 'KalturaRoomDetails', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
 		# Append recorded video to live entry
 		# @return [KalturaLiveEntry]
 		def append_recording(entry_id, asset_id, media_server_index, resource, duration, is_last_chunk=false)
@@ -2565,6 +2578,19 @@ module Kaltura
 			return client.do_queue()
 		end
 
+		# When the conf is finished this API should be called.
+		# @return [bool]
+		def finish_conf(entry_id, server_node_id=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'serverNodeId', server_node_id)
+			client.queue_service_action_call('livestream', 'finishConf', 'bool', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
 		# Get live stream entry by ID.
 		# @return [KalturaLiveStreamEntry]
 		def get(entry_id, version=-1)
@@ -2628,6 +2654,18 @@ module Kaltura
 			return client.do_queue()
 		end
 
+		# Mark that the conference has actually started
+		# @return [bool]
+		def register_conf(entry_id)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('livestream', 'registerConf', 'bool', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
 		# Register media server to live entry
 		# @return [KalturaLiveEntry]
 		def register_media_server(entry_id, hostname, media_server_index, application_name=KalturaNotImplemented, live_entry_status=1, should_create_recorded_entry=true)
@@ -5661,9 +5699,10 @@ module Kaltura
 
 		# Reset user's password and send the user an email to generate a new one.
 		# @return []
-		def reset_password(email)
+		def reset_password(email, link_type=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'email', email)
+			client.add_param(kparams, 'linkType', link_type)
 			client.queue_service_action_call('user', 'resetPassword', '', kparams)
 			if (client.is_multirequest)
 				return nil
@@ -5727,6 +5766,18 @@ module Kaltura
 			end
 			return client.do_queue()
 		end
+
+		# Validate hash key
+		# @return [KalturaAuthentication]
+		def validate_hash_key(hash_key)
+			kparams = {}
+			client.add_param(kparams, 'hashKey', hash_key)
+			client.queue_service_action_call('user', 'validateHashKey', 'KalturaAuthentication', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
 	end
 
 	# widget service for full widget management
@@ -6243,8 +6294,8 @@ module Kaltura
 		
 		def initialize(client)
 			super(client)
-			self.client_tag = 'ruby:20-03-31'
-			self.api_version = '15.20.0'
+			self.client_tag = 'ruby:20-09-24'
+			self.api_version = '16.8.0'
 		end
 		
 		def client_tag=(value)

data/lib/kaltura_enums.rb

@@ -448,6 +448,7 @@ module Kaltura
 		STATIC_LIST = 3
 		DYNAMIC = 10
 		EXTERNAL = 101
+		PATH = 102
 	end
 
 	class KalturaPrivacyType
@@ -1131,6 +1132,10 @@ module Kaltura
 		REPORT_EXPORT = "50"
 		LIVE_ENTRY_ARCHIVE = "51"
 		STORAGE_UPDATE = "52"
+		STORAGE_PERIODIC_EXPORT = "53"
+		STORAGE_PERIODIC_PURGE = "54"
+		STORAGE_PERIODIC_DELETE_LOCAL = "55"
+		REACH_JOB_CLEANER = "56"
 	end
 
 	class KalturaBulkUploadAction
@@ -1143,6 +1148,7 @@ module Kaltura
 		ADD_OR_UPDATE = "6"
 		ACTIVATE = "7"
 		REJECT = "8"
+		UPDATE_STATUS = "9"
 	end
 
 	class KalturaBulkUploadObjectType
@@ -1155,6 +1161,7 @@ module Kaltura
 		CATEGORY_USER = "4"
 		CATEGORY_ENTRY = "5"
 		USER_ENTRY = "6"
+		VENDOR_CATALOG_ITEM = "7"
 	end
 
 	class KalturaBulkUploadOrderBy
@@ -1616,6 +1623,17 @@ module Kaltura
 		UPDATED_AT_DESC = "-updatedAt"
 	end
 
+	class KalturaEntryApplication
+		KMC = "0"
+		KMS = "1"
+		KAF = "2"
+		PITCH = "3"
+		KMS_GO = "4"
+		WEBCAST_APP = "5"
+		PERSONAL_CAPTURE = "6"
+		KALTURA_MEETING = "7"
+	end
+
 	class KalturaEntryIdentifierField
 		ID = "id"
 		REFERENCE_ID = "referenceId"
@@ -1659,7 +1677,9 @@ module Kaltura
 
 	class KalturaEntryType
 		AUTOMATIC = "-1"
+		CONFERENCE_ENTRY_SERVER = "conference.CONFERENCE_ENTRY_SERVER"
 		EXTERNAL_MEDIA = "externalMedia.externalMedia"
+		SIP_ENTRY_SERVER = "sip.SIP_ENTRY_SERVER"
 		MEDIA_CLIP = "1"
 		MIX = "2"
 		PLAYLIST = "5"
@@ -3518,6 +3538,13 @@ module Kaltura
 		INTERACTIVE_VIDEO_TOP_NODES = "50"
 		LATEST_PLAYED_ENTRIES = "51"
 		CATEGORY_HIGHLIGHTS = "52"
+		SUB_CATEGORIES = "53"
+		INTERACTIVE_VIDEO_NODE_TOP_HOTSPOTS = "54"
+		INTERCATIVE_VIDEO_NODE_SWITCH_TOP_HOTSPOTS = "55"
+		INTERACTIVE_VIDEO_HOTSPOT_CLICKED_PERCENTILES = "56"
+		INTERACTIVE_VIDEO_NODE_SWITCH_HOTSPOT_CLICKED_PERCENTILES = "57"
+		TOP_CUSTOM_VAR2 = "58"
+		TOP_CUSTOM_VAR3 = "59"
 		PARTNER_USAGE = "201"
 		MAP_OVERLAY_COUNTRY_REALTIME = "10001"
 		MAP_OVERLAY_REGION_REALTIME = "10002"
@@ -3532,6 +3559,8 @@ module Kaltura
 		PLAYBACK_TYPE_REALTIME = "10011"
 		CONTENT_REALTIME = "10012"
 		DISCOVERY_VIEW_REALTIME = "10013"
+		TOP_ENDED_BROADCAST_ENTRIES = "10014"
+		TOP_LIVE_NOW_ENTRIES = "10015"
 		CONTENT_DROPOFF_VPAAS = "20001"
 		TOP_SYNDICATION_VPAAS = "20002"
 		USER_TOP_CONTENT_VPAAS = "20003"
@@ -3620,6 +3649,11 @@ module Kaltura
 		QOE_ERROR_TRACKING_APPLICATION_VERSION = "30064"
 	end
 
+	class KalturaResetPassLinkType
+		KMC = "1"
+		KMS = "2"
+	end
+
 	class KalturaResponseProfileOrderBy
 		CREATED_AT_ASC = "+createdAt"
 		UPDATED_AT_ASC = "+updatedAt"
@@ -3668,6 +3702,9 @@ module Kaltura
 	end
 
 	class KalturaServerNodeType
+		CONFERENCE_SERVER = "conference.CONFERENCE_SERVER"
+		LIVE_CLUSTER_MEDIA_SERVER = "liveCluster.LIVE_CLUSTER_MEDIA_SERVER"
+		SIP_SERVER = "sip.SIP_SERVER"
 		WOWZA_MEDIA_SERVER = "wowza.WOWZA_MEDIA_SERVER"
 		EDGE = "1"
 	end
@@ -3799,6 +3836,7 @@ module Kaltura
 
 	class KalturaUserEntryType
 		QUIZ = "quiz.QUIZ"
+		REGISTRATION = "registration.REGISTRATION"
 		VIEW_HISTORY = "viewHistory.VIEW_HISTORY"
 		WATCH_LATER = "watchLater.WATCH_LATER"
 	end

data/lib/kaltura_plugins/kaltura_audit_client_plugin.rb

@@ -75,6 +75,7 @@ module Kaltura
 		METADATA_PROFILE = "MetadataProfile"
 		PARTNER = "Partner"
 		PERMISSION = "Permission"
+		REACH_PROFILE = "ReachProfile"
 		UPLOAD_TOKEN = "UploadToken"
 		USER_LOGIN_DATA = "UserLoginData"
 		USER_ROLE = "UserRole"

data/lib/kaltura_plugins/kaltura_caption_client_plugin.rb

@@ -434,6 +434,19 @@ module Kaltura
 			return client.do_queue()
 		end
 
+		# manually export an asset
+		# @return [KalturaFlavorAsset]
+		def export(asset_id, storage_profile_id)
+			kparams = {}
+			client.add_param(kparams, 'assetId', asset_id)
+			client.add_param(kparams, 'storageProfileId', storage_profile_id)
+			client.queue_service_action_call('caption_captionasset', 'export', 'KalturaFlavorAsset', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
 		# @return [KalturaCaptionAsset]
 		def get(caption_asset_id)
 			kparams = {}

data/lib/kaltura_plugins/kaltura_capture_space_client_plugin.rb

@@ -0,0 +1,36 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# This file is part of the Kaltura Collaborative Media Suite which allows users
+# to do with audio, video, and animation what Wiki platfroms allow them to do with
+# text.
+#
+# Copyright (C) 2006-2020  Kaltura Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http:#www.gnu.org/licenses/>.
+#
+# @ignore
+# ===================================================================================================
+require 'kaltura_client.rb'
+
+module Kaltura
+
+
+	class KalturaClient < KalturaClientBase
+	end
+
+end

data/lib/kaltura_plugins/kaltura_conference_client_plugin.rb

@@ -0,0 +1,152 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# This file is part of the Kaltura Collaborative Media Suite which allows users
+# to do with audio, video, and animation what Wiki platfroms allow them to do with
+# text.
+#
+# Copyright (C) 2006-2020  Kaltura Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http:#www.gnu.org/licenses/>.
+#
+# @ignore
+# ===================================================================================================
+require 'kaltura_client.rb'
+
+module Kaltura
+
+	class KalturaConferenceRoomStatus
+		CREATED = 1
+		READY = 2
+		ENDED = 3
+	end
+
+	class KalturaConferenceServerNodeOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		HEARTBEAT_TIME_ASC = "+heartbeatTime"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		HEARTBEAT_TIME_DESC = "-heartbeatTime"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	class KalturaRoomDetails < KalturaObjectBase
+		attr_accessor :server_url
+		attr_accessor :entry_id
+		attr_accessor :token
+		attr_accessor :expiry
+		attr_accessor :server_name
+
+		def expiry=(val)
+			@expiry = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['serverUrl'] != nil
+				self.server_url = xml_element.elements['serverUrl'].text
+			end
+			if xml_element.elements['entryId'] != nil
+				self.entry_id = xml_element.elements['entryId'].text
+			end
+			if xml_element.elements['token'] != nil
+				self.token = xml_element.elements['token'].text
+			end
+			if xml_element.elements['expiry'] != nil
+				self.expiry = xml_element.elements['expiry'].text
+			end
+			if xml_element.elements['serverName'] != nil
+				self.server_name = xml_element.elements['serverName'].text
+			end
+		end
+
+	end
+
+	class KalturaConferenceEntryServerNode < KalturaEntryServerNode
+		attr_accessor :conf_room_status
+		attr_accessor :registered
+
+		def conf_room_status=(val)
+			@conf_room_status = val.to_i
+		end
+		def registered=(val)
+			@registered = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['confRoomStatus'] != nil
+				self.conf_room_status = xml_element.elements['confRoomStatus'].text
+			end
+			if xml_element.elements['registered'] != nil
+				self.registered = xml_element.elements['registered'].text
+			end
+		end
+
+	end
+
+	class KalturaConferenceServerNode < KalturaServerNode
+		attr_accessor :service_base_url
+
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['serviceBaseUrl'] != nil
+				self.service_base_url = xml_element.elements['serviceBaseUrl'].text
+			end
+		end
+
+	end
+
+	class KalturaConferenceEntryServerNodeBaseFilter < KalturaEntryServerNodeFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaConferenceServerNodeBaseFilter < KalturaServerNodeFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaConferenceEntryServerNodeFilter < KalturaConferenceEntryServerNodeBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaConferenceServerNodeFilter < KalturaConferenceServerNodeBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+
+end