kaltura-client 16.0.0 → 16.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 052506f07ff75b3577400c88f6947ace39b15fa41106e415bdf78b057d3bd799
-  data.tar.gz: f77ccb39333c027d0a94653f308fd5728ec3d381c6ff75c9e37ead7dbda6283c
+  metadata.gz: f604d5ca1a9cab6f62d61dd985a86dabf7d51168fa9c28a161135da3153a51df
+  data.tar.gz: 943ce9308c70d3c63ec201818c65da97e39953825a85f67fb07c4ba7c958f588
 SHA512:
-  metadata.gz: 9747036dc4b457fa7f07c858acf7d8fc541bca76af93f4bd6c48028a75aba5f5a03dfc24bf90858fa6ab4437e23cc1e44ad332c21563b4faf7d5cfc999f3ebd5
-  data.tar.gz: e31a7211cec66e5bfacd9508b193693d16736f9577b6f6e16afd79985cb22897f528b036fc2bcaa56f5955ec9c4a629405963921adf1f787771abb8d4e1afdb0
+  metadata.gz: 7087c77cd0de30e21e41eb0fdfe0fbd1927e41c7ca5dbae189099babfb3a967bdc1b14e647098755d205b0afc8ad831d339ed4bb8393f178745286f6f5ceac14
+  data.tar.gz: b8157a5c6ce6e124975cea629b9523174ecf7111e26ddabefd00c40fd3b3ae774cdc366e03c04835061ffdd9adba27ccb99316f74d55d2d3478f77bda6397d3c

data/README

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

data/lib/kaltura_client.rb

@@ -2618,7 +2618,7 @@ module Kaltura
 
 		# Delivering the status of a live stream (on-air/offline) if it is possible
 		# @return [bool]
-		def is_live(id, protocol)
+		def is_live(id, protocol=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'id', id)
 			client.add_param(kparams, 'protocol', protocol)
@@ -5699,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
@@ -5765,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
@@ -6281,8 +6294,8 @@ module Kaltura
 		
 		def initialize(client)
 			super(client)
-			self.client_tag = 'ruby:20-04-25'
-			self.api_version = '16.0.0'
+			self.client_tag = 'ruby:20-10-15'
+			self.api_version = '16.9.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"
@@ -2075,6 +2093,7 @@ module Kaltura
 		FRP = "Franco-Prove"
 		FRK = "Frankish"
 		FR = "French"
+		FR_CA = "French (Canada)"
 		FY = "Frisian"
 		FRR = "Frisian Northern"
 		FUR = "Friulian"
@@ -2108,8 +2127,8 @@ module Kaltura
 		HNI = "Hani"
 		HA = "Hausa"
 		HAW = "Hawaiian"
-		HE = "Hebrew"
 		IW = "Hebrew"
+		HE = "Hebrew"
 		HEI = "Heiltsuk"
 		HID = "Hidatsa"
 		HIL = "Hiligaynon"
@@ -2123,8 +2142,8 @@ module Kaltura
 		KPO = "Ikposo"
 		ILO = "Iloko"
 		SMN = "Inari Sami"
-		ID = "Indonesian"
 		IN = "Indonesian"
+		ID = "Indonesian"
 		IZH = "Ingrian"
 		INH = "Ingush"
 		IA = "Interlingua"
@@ -2404,6 +2423,7 @@ module Kaltura
 		TGX = "Tagish"
 		THT = "Tahltan"
 		TDD = "Tai Na"
+		ZH_TW = "Taiwanese Mandarin"
 		TG = "Tajik"
 		TLY = "Talysh"
 		TTQ = "Tamajaq Tawallammat"
@@ -2521,6 +2541,7 @@ module Kaltura
 		FJ = "fj"
 		FO = "fo"
 		FR = "fr"
+		FR_CA = "fr_ca"
 		FY = "fy"
 		GA = "ga"
 		GD = "gd"
@@ -2643,6 +2664,7 @@ module Kaltura
 		YI = "yi"
 		YO = "yo"
 		ZH = "zh"
+		ZH_TW = "zh_tw"
 		ZU = "zu"
 		ZXX = "zxx"
 	end
@@ -3520,6 +3542,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"
@@ -3534,6 +3563,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 +3651,22 @@ module Kaltura
 		QOE_ENGAGEMENT_APPLICATION_VERSION = "30062"
 		QOE_STREAM_QUALITY_APPLICATION_VERSION = "30063"
 		QOE_ERROR_TRACKING_APPLICATION_VERSION = "30064"
+		HIGHLIGHTS_WEBCAST = "40001"
+		ENGAGEMENT_WEBCAST = "40002"
+		QUALITY_WEBCAST = "40003"
+		MAP_OVERLAY_COUNTRY_WEBCAST = "40004"
+		MAP_OVERLAY_REGION_WEBCAST = "40005"
+		MAP_OVERLAY_CITY_WEBCAST = "40006"
+		PLATFORMS_WEBCAST = "40007"
+		TOP_DOMAINS_WEBCAST = "40008"
+		TOP_USERS_WEBCAST = "40009"
+		ENGAGEMENT_BREAKDOWN_WEBCAST = "40010"
+		ENGAGMENT_TIMELINE_WEBCAST = "40011"
+	end
+
+	class KalturaResetPassLinkType
+		KMC = "1"
+		KMS = "2"
 	end
 
 	class KalturaResponseProfileOrderBy

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_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_drop_folder_client_plugin.rb

@@ -1263,6 +1263,18 @@ module Kaltura
 			end
 			return client.do_queue()
 		end
+
+		# @return []
+		def update_status(drop_folder_id, status)
+			kparams = {}
+			client.add_param(kparams, 'dropFolderId', drop_folder_id)
+			client.add_param(kparams, 'status', status)
+			client.queue_service_action_call('dropfolder_dropfolder', 'updateStatus', '', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
 	end
 
 	# DropFolderFile service lets you create and manage drop folder files

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

data/lib/kaltura_plugins/kaltura_http_notification_client_plugin.rb

@@ -317,6 +317,8 @@ module Kaltura
 		attr_accessor :url
 		# Request method.
 		attr_accessor :method
+		# The type of the data to send.
+		attr_accessor :content_type
 		# Data to send.
 		attr_accessor :data
 		# The maximum number of seconds to allow cURL functions to execute.
@@ -378,6 +380,9 @@ module Kaltura
 			if xml_element.elements['method'] != nil
 				self.method = xml_element.elements['method'].text
 			end
+			if xml_element.elements['contentType'] != nil
+				self.content_type = xml_element.elements['contentType'].text
+			end
 			if xml_element.elements['data'] != nil
 				self.data = xml_element.elements['data'].text
 			end

data/lib/kaltura_plugins/kaltura_interactivity_client_plugin.rb

@@ -0,0 +1,280 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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'
+require File.dirname(__FILE__) + '/kaltura_file_sync_client_plugin.rb'
+
+module Kaltura
+
+	class KalturaBaseInteractivity < KalturaObjectBase
+		attr_accessor :data
+		attr_accessor :version
+		attr_accessor :entry_id
+		# Interactivity update date as Unix timestamp (In seconds)
+		attr_accessor :updated_at
+
+		def version=(val)
+			@version = val.to_i
+		end
+		def updated_at=(val)
+			@updated_at = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['data'] != nil
+				self.data = xml_element.elements['data'].text
+			end
+			if xml_element.elements['version'] != nil
+				self.version = xml_element.elements['version'].text
+			end
+			if xml_element.elements['entryId'] != nil
+				self.entry_id = xml_element.elements['entryId'].text
+			end
+			if xml_element.elements['updatedAt'] != nil
+				self.updated_at = xml_element.elements['updatedAt'].text
+			end
+		end
+
+	end
+
+	class KalturaInteractivityDataFieldsFilter < KalturaObjectBase
+		# A string containing CSV list of fields to include
+		attr_accessor :fields
+
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['fields'] != nil
+				self.fields = xml_element.elements['fields'].text
+			end
+		end
+
+	end
+
+	class KalturaInteractivityRootFilter < KalturaInteractivityDataFieldsFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaInteractivityNodeFilter < KalturaInteractivityDataFieldsFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaInteractivityInteractionFilter < KalturaInteractivityDataFieldsFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaInteractivityDataFilter < KalturaObjectBase
+		attr_accessor :root_filter
+		attr_accessor :node_filter
+		attr_accessor :interaction_filter
+
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['rootFilter'] != nil
+				self.root_filter = KalturaClientBase.object_from_xml(xml_element.elements['rootFilter'], 'KalturaInteractivityRootFilter')
+			end
+			if xml_element.elements['nodeFilter'] != nil
+				self.node_filter = KalturaClientBase.object_from_xml(xml_element.elements['nodeFilter'], 'KalturaInteractivityNodeFilter')
+			end
+			if xml_element.elements['interactionFilter'] != nil
+				self.interaction_filter = KalturaClientBase.object_from_xml(xml_element.elements['interactionFilter'], 'KalturaInteractivityInteractionFilter')
+			end
+		end
+
+	end
+
+	class KalturaInteractivity < KalturaBaseInteractivity
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaVolatileInteractivity < KalturaBaseInteractivity
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+
+	class KalturaInteractivityService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# Add a interactivity object
+		# @return [KalturaInteractivity]
+		def add(entry_id, kaltura_interactivity)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'kalturaInteractivity', kaltura_interactivity)
+			client.queue_service_action_call('interactivity_interactivity', 'add', 'KalturaInteractivity', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Delete a interactivity object by entry id
+		# @return []
+		def delete(entry_id)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('interactivity_interactivity', 'delete', '', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Retrieve a interactivity object by entry id
+		# @return [KalturaInteractivity]
+		def get(entry_id, data_filter=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'dataFilter', data_filter)
+			client.queue_service_action_call('interactivity_interactivity', 'get', 'KalturaInteractivity', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Update an existing interactivity object
+		# @return [KalturaInteractivity]
+		def update(entry_id, version, kaltura_interactivity)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'version', version)
+			client.add_param(kparams, 'kalturaInteractivity', kaltura_interactivity)
+			client.queue_service_action_call('interactivity_interactivity', 'update', 'KalturaInteractivity', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+	end
+
+	class KalturaVolatileInteractivityService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# add a volatile interactivity object
+		# @return [KalturaVolatileInteractivity]
+		def add(entry_id, kaltura_volatile_interactivity)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'kalturaVolatileInteractivity', kaltura_volatile_interactivity)
+			client.queue_service_action_call('interactivity_volatileinteractivity', 'add', 'KalturaVolatileInteractivity', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Delete a volatile interactivity object by entry id
+		# @return []
+		def delete(entry_id)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('interactivity_volatileinteractivity', 'delete', '', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Retrieve a volatile interactivity object by entry id
+		# @return [KalturaVolatileInteractivity]
+		def get(entry_id)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('interactivity_volatileinteractivity', 'get', 'KalturaVolatileInteractivity', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Update a volatile interactivity object
+		# @return [KalturaVolatileInteractivity]
+		def update(entry_id, version, kaltura_volatile_interactivity)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'version', version)
+			client.add_param(kparams, 'kalturaVolatileInteractivity', kaltura_volatile_interactivity)
+			client.queue_service_action_call('interactivity_volatileinteractivity', 'update', 'KalturaVolatileInteractivity', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :interactivity_service
+		def interactivity_service
+			if (@interactivity_service == nil)
+				@interactivity_service = KalturaInteractivityService.new(self)
+			end
+			return @interactivity_service
+		end
+		
+		attr_reader :volatile_interactivity_service
+		def volatile_interactivity_service
+			if (@volatile_interactivity_service == nil)
+				@volatile_interactivity_service = KalturaVolatileInteractivityService.new(self)
+			end
+			return @volatile_interactivity_service
+		end
+		
+	end
+
+end