kaltura-client 15.17.0 → 16.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6cd99fe7092b43a5b335ea2f636b6c8e2a2454247afcd61dd28ec3d0bbb7fac
-  data.tar.gz: e24af7fd275a1fcb37e3405d42c075feade0f982f23ff3815c2b34c118f9a7ee
+  metadata.gz: b3ecc027bf2ab1e47a369193f1321d9f91b2de970a6811daf06c01618ec14ffb
+  data.tar.gz: 0e993fdde1919f5b4417ac1a1c68baa08a5e4fa68987a6589fea4fc1221dc879
 SHA512:
-  metadata.gz: 5de5583800cf931a09988bb4dce06badc1150ade94513d534d07a4c04f1a504360acbac39b8091b76492720f3c2e58f90dfcf486857bbdb57b51d061bbb5799f
-  data.tar.gz: f46660ab7f1289cfb9cd0ff9780fc54fe4783a75bdc01d9627a4f080d22a2dd15d24bf60161da66b6db589ba66ab5dfddf836b34fd203f8f5c8e2f780f03f44e
+  metadata.gz: 604a4034540c8ff6fdda591e91ee2e19fac493943f88c0b98a471b08ad0230f35a25eddb79f4aa49053f8d81976fb9cac7d60e7d523342cc0bdb711140885ec5
+  data.tar.gz: e327c9811b6251ae97e9a76cf20ae12b5e1350b3a2dc9c2ffa887f5e6a5157e3435e6c5f9604f84e6724a8a066612a1876cfcd114af4dcdf589c19f51876260b

data/README

@@ -1,5 +1,5 @@
 Kaltura Ruby API Client Library.
-Compatible with Kaltura server version 15.17.0 and above.
+Compatible with Kaltura server version 16.4.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)
@@ -5727,6 +5765,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 +6293,8 @@ module Kaltura
 		
 		def initialize(client)
 			super(client)
-			self.client_tag = 'ruby:20-02-17'
-			self.api_version = '15.17.0'
+			self.client_tag = 'ruby:20-06-15'
+			self.api_version = '16.4.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
@@ -1130,6 +1131,10 @@ module Kaltura
 		EXPORT_CSV = "49"
 		REPORT_EXPORT = "50"
 		LIVE_ENTRY_ARCHIVE = "51"
+		STORAGE_UPDATE = "52"
+		STORAGE_PERIODIC_EXPORT = "53"
+		STORAGE_PERIODIC_PURGE = "54"
+		STORAGE_PERIODIC_DELETE_LOCAL = "55"
 	end
 
 	class KalturaBulkUploadAction
@@ -1142,6 +1147,7 @@ module Kaltura
 		ADD_OR_UPDATE = "6"
 		ACTIVATE = "7"
 		REJECT = "8"
+		UPDATE_STATUS = "9"
 	end
 
 	class KalturaBulkUploadObjectType
@@ -1154,6 +1160,7 @@ module Kaltura
 		CATEGORY_USER = "4"
 		CATEGORY_ENTRY = "5"
 		USER_ENTRY = "6"
+		VENDOR_CATALOG_ITEM = "7"
 	end
 
 	class KalturaBulkUploadOrderBy
@@ -1658,7 +1665,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"
@@ -3054,6 +3063,7 @@ module Kaltura
 		MAIL_TYPE_VIDEO_SERVICE_NOTICE_ACCOUNT_DELETED = "84"
 		MAIL_TYPE_VIDEO_SERVICE_NOTICE_UPGRADE_OFFER = "85"
 		MAIL_TYPE_ACCOUNT_REACTIVE_CONFIRM = "86"
+		MAIL_TYPE_EXTENDED_FREE_TRIAL_ENDS_WARNING = "87"
 		MAIL_TYPE_SYSTEM_USER_RESET_PASSWORD = "110"
 		MAIL_TYPE_SYSTEM_USER_RESET_PASSWORD_SUCCESS = "111"
 		MAIL_TYPE_SYSTEM_USER_NEW_PASSWORD = "112"
@@ -3515,6 +3525,10 @@ module Kaltura
 		USER_INTERACTIVE_VIDEO = "49"
 		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"
 		PARTNER_USAGE = "201"
 		MAP_OVERLAY_COUNTRY_REALTIME = "10001"
 		MAP_OVERLAY_REGION_REALTIME = "10002"
@@ -3665,6 +3679,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
@@ -3796,7 +3813,9 @@ module Kaltura
 
 	class KalturaUserEntryType
 		QUIZ = "quiz.QUIZ"
+		REGISTRATION = "registration.REGISTRATION"
 		VIEW_HISTORY = "viewHistory.VIEW_HISTORY"
+		WATCH_LATER = "watchLater.WATCH_LATER"
 	end
 
 	class KalturaUserLoginDataOrderBy

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

data/lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb

@@ -161,6 +161,7 @@ module Kaltura
 		IDETIC = "ideticDistribution.IDETIC"
 		METRO_PCS = "metroPcsDistribution.METRO_PCS"
 		MSN = "msnDistribution.MSN"
+		PODCAST = "podcastDistribution.PODCAST"
 		QUICKPLAY = "quickPlayDistribution.QUICKPLAY"
 		UNICORN = "unicornDistribution.UNICORN"
 		YAHOO = "yahooDistribution.YAHOO"

data/lib/kaltura_plugins/kaltura_cross_kaltura_distribution_client_plugin.rb

@@ -58,6 +58,8 @@ module Kaltura
 		attr_accessor :distributed_metadata
 		# Key-value array where the keys are IDs of distributed caption assets in the source account and the values are the matching IDs in the target account
 		attr_accessor :distributed_caption_assets
+		# Key-value array where the keys are IDs of distributed fileassets in the source account and the values are the matching IDs in the target account
+		attr_accessor :distributed_file_assets
 		# Key-value array where the keys are IDs of distributed caption assets in the source account and the values are the matching IDs in the target account
 		attr_accessor :distributed_attachment_assets
 		# Key-value array where the keys are IDs of distributed cue points in the source account and the values are the matching IDs in the target account
@@ -82,6 +84,9 @@ module Kaltura
 			if xml_element.elements['distributedCaptionAssets'] != nil
 				self.distributed_caption_assets = xml_element.elements['distributedCaptionAssets'].text
 			end
+			if xml_element.elements['distributedFileAssets'] != nil
+				self.distributed_file_assets = xml_element.elements['distributedFileAssets'].text
+			end
 			if xml_element.elements['distributedAttachmentAssets'] != nil
 				self.distributed_attachment_assets = xml_element.elements['distributedAttachmentAssets'].text
 			end

data/lib/kaltura_plugins/kaltura_file_sync_client_plugin.rb

@@ -84,6 +84,9 @@ module Kaltura
 		attr_accessor :is_current_dc
 		attr_accessor :is_dir
 		attr_accessor :original_id
+		attr_accessor :src_path
+		attr_accessor :src_enc_key
+		attr_accessor :storage_class
 
 		def id=(val)
 			@id = val.to_i
@@ -214,6 +217,15 @@ module Kaltura
 			if xml_element.elements['originalId'] != nil
 				self.original_id = xml_element.elements['originalId'].text
 			end
+			if xml_element.elements['srcPath'] != nil
+				self.src_path = xml_element.elements['srcPath'].text
+			end
+			if xml_element.elements['srcEncKey'] != nil
+				self.src_enc_key = xml_element.elements['srcEncKey'].text
+			end
+			if xml_element.elements['storageClass'] != nil
+				self.storage_class = xml_element.elements['storageClass'].text
+			end
 		end
 
 	end