kaltura-client 3.3.0 → 14.15.0

data/lib/kaltura_plugins/kaltura_dailymotion_distribution_client_plugin.rb

@@ -0,0 +1,199 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2019  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_content_distribution_client_plugin.rb'
+
+module Kaltura
+
+	class KalturaDailymotionDistributionCaptionAction
+		UPDATE_ACTION = 1
+		SUBMIT_ACTION = 2
+		DELETE_ACTION = 3
+	end
+
+	class KalturaDailymotionDistributionCaptionFormat
+		SRT = 1
+		STL = 2
+		TT = 3
+	end
+
+	class KalturaDailymotionGeoBlockingMapping
+		DISABLED = 0
+		ACCESS_CONTROL = 1
+		METADATA = 2
+	end
+
+	class KalturaDailymotionDistributionProfileOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	class KalturaDailymotionDistributionProviderOrderBy
+	end
+
+	class KalturaDailymotionDistributionCaptionInfo < KalturaObjectBase
+		attr_accessor :language
+		attr_accessor :file_path
+		attr_accessor :remote_id
+		attr_accessor :action
+		attr_accessor :version
+		attr_accessor :asset_id
+		attr_accessor :format
+
+		def action=(val)
+			@action = val.to_i
+		end
+		def format=(val)
+			@format = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['language'] != nil
+				self.language = xml_element.elements['language'].text
+			end
+			if xml_element.elements['filePath'] != nil
+				self.file_path = xml_element.elements['filePath'].text
+			end
+			if xml_element.elements['remoteId'] != nil
+				self.remote_id = xml_element.elements['remoteId'].text
+			end
+			if xml_element.elements['action'] != nil
+				self.action = xml_element.elements['action'].text
+			end
+			if xml_element.elements['version'] != nil
+				self.version = xml_element.elements['version'].text
+			end
+			if xml_element.elements['assetId'] != nil
+				self.asset_id = xml_element.elements['assetId'].text
+			end
+			if xml_element.elements['format'] != nil
+				self.format = xml_element.elements['format'].text
+			end
+		end
+
+	end
+
+	class KalturaDailymotionDistributionProvider < KalturaDistributionProvider
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaDailymotionDistributionJobProviderData < KalturaConfigurableDistributionJobProviderData
+		attr_accessor :video_asset_file_path
+		attr_accessor :access_control_geo_blocking_operation
+		attr_accessor :access_control_geo_blocking_country_list
+		attr_accessor :captions_info
+
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['videoAssetFilePath'] != nil
+				self.video_asset_file_path = xml_element.elements['videoAssetFilePath'].text
+			end
+			if xml_element.elements['accessControlGeoBlockingOperation'] != nil
+				self.access_control_geo_blocking_operation = xml_element.elements['accessControlGeoBlockingOperation'].text
+			end
+			if xml_element.elements['accessControlGeoBlockingCountryList'] != nil
+				self.access_control_geo_blocking_country_list = xml_element.elements['accessControlGeoBlockingCountryList'].text
+			end
+			if xml_element.elements['captionsInfo'] != nil
+				self.captions_info = KalturaClientBase.object_from_xml(xml_element.elements['captionsInfo'], 'KalturaDailymotionDistributionCaptionInfo')
+			end
+		end
+
+	end
+
+	class KalturaDailymotionDistributionProfile < KalturaConfigurableDistributionProfile
+		attr_accessor :user
+		attr_accessor :password
+		attr_accessor :geo_blocking_mapping
+
+		def geo_blocking_mapping=(val)
+			@geo_blocking_mapping = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['user'] != nil
+				self.user = xml_element.elements['user'].text
+			end
+			if xml_element.elements['password'] != nil
+				self.password = xml_element.elements['password'].text
+			end
+			if xml_element.elements['geoBlockingMapping'] != nil
+				self.geo_blocking_mapping = xml_element.elements['geoBlockingMapping'].text
+			end
+		end
+
+	end
+
+	class KalturaDailymotionDistributionProviderBaseFilter < KalturaDistributionProviderFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaDailymotionDistributionProviderFilter < KalturaDailymotionDistributionProviderBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaDailymotionDistributionProfileBaseFilter < KalturaConfigurableDistributionProfileFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaDailymotionDistributionProfileFilter < KalturaDailymotionDistributionProfileBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+
+end

data/lib/kaltura_plugins/kaltura_document_client_plugin.rb

@@ -8,7 +8,7 @@
 # to do with audio, video, and animation what Wiki platfroms allow them to do with
 # text.
 #
-# Copyright (C) 2006-2015  Kaltura Inc.
+# Copyright (C) 2006-2019  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
@@ -86,10 +86,8 @@ module Kaltura
 
 	class KalturaDocumentEntry < KalturaBaseEntry
 		# The type of the document
-		# 	 
 		attr_accessor :document_type
 		# Comma separated asset params ids that exists for this media entry
-		# 	 
 		attr_accessor :asset_params_ids
 
 		def document_type=(val)
@@ -98,8 +96,12 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.document_type = xml_element.elements['documentType'].text
-			self.asset_params_ids = xml_element.elements['assetParamsIds'].text
+			if xml_element.elements['documentType'] != nil
+				self.document_type = xml_element.elements['documentType'].text
+			end
+			if xml_element.elements['assetParamsIds'] != nil
+				self.asset_params_ids = xml_element.elements['assetParamsIds'].text
+			end
 		end
 
 	end
@@ -110,7 +112,9 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaDocumentEntry')
+			if xml_element.elements['objects'] != nil
+				self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaDocumentEntry')
+			end
 		end
 
 	end
@@ -149,11 +153,21 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.density_width = xml_element.elements['densityWidth'].text
-			self.density_height = xml_element.elements['densityHeight'].text
-			self.size_width = xml_element.elements['sizeWidth'].text
-			self.size_height = xml_element.elements['sizeHeight'].text
-			self.depth = xml_element.elements['depth'].text
+			if xml_element.elements['densityWidth'] != nil
+				self.density_width = xml_element.elements['densityWidth'].text
+			end
+			if xml_element.elements['densityHeight'] != nil
+				self.density_height = xml_element.elements['densityHeight'].text
+			end
+			if xml_element.elements['sizeWidth'] != nil
+				self.size_width = xml_element.elements['sizeWidth'].text
+			end
+			if xml_element.elements['sizeHeight'] != nil
+				self.size_height = xml_element.elements['sizeHeight'].text
+			end
+			if xml_element.elements['depth'] != nil
+				self.depth = xml_element.elements['depth'].text
+			end
 		end
 
 	end
@@ -167,7 +181,9 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.readonly = xml_element.elements['readonly'].text
+			if xml_element.elements['readonly'] != nil
+				self.readonly = xml_element.elements['readonly'].text
+			end
 		end
 
 	end
@@ -185,8 +201,12 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.flash_version = xml_element.elements['flashVersion'].text
-			self.poly2bitmap = xml_element.elements['poly2Bitmap'].text
+			if xml_element.elements['flashVersion'] != nil
+				self.flash_version = xml_element.elements['flashVersion'].text
+			end
+			if xml_element.elements['poly2Bitmap'] != nil
+				self.poly2bitmap = xml_element.elements['poly2Bitmap'].text
+			end
 		end
 
 	end
@@ -225,11 +245,21 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.density_width = xml_element.elements['densityWidth'].text
-			self.density_height = xml_element.elements['densityHeight'].text
-			self.size_width = xml_element.elements['sizeWidth'].text
-			self.size_height = xml_element.elements['sizeHeight'].text
-			self.depth = xml_element.elements['depth'].text
+			if xml_element.elements['densityWidth'] != nil
+				self.density_width = xml_element.elements['densityWidth'].text
+			end
+			if xml_element.elements['densityHeight'] != nil
+				self.density_height = xml_element.elements['densityHeight'].text
+			end
+			if xml_element.elements['sizeWidth'] != nil
+				self.size_width = xml_element.elements['sizeWidth'].text
+			end
+			if xml_element.elements['sizeHeight'] != nil
+				self.size_height = xml_element.elements['sizeHeight'].text
+			end
+			if xml_element.elements['depth'] != nil
+				self.depth = xml_element.elements['depth'].text
+			end
 		end
 
 	end
@@ -243,7 +273,9 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.readonly = xml_element.elements['readonly'].text
+			if xml_element.elements['readonly'] != nil
+				self.readonly = xml_element.elements['readonly'].text
+			end
 		end
 
 	end
@@ -261,8 +293,12 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.flash_version = xml_element.elements['flashVersion'].text
-			self.poly2bitmap = xml_element.elements['poly2Bitmap'].text
+			if xml_element.elements['flashVersion'] != nil
+				self.flash_version = xml_element.elements['flashVersion'].text
+			end
+			if xml_element.elements['poly2Bitmap'] != nil
+				self.poly2bitmap = xml_element.elements['poly2Bitmap'].text
+			end
 		end
 
 	end
@@ -279,10 +315,18 @@ module Kaltura
 
 		def from_xml(xml_element)
 			super
-			self.document_type_equal = xml_element.elements['documentTypeEqual'].text
-			self.document_type_in = xml_element.elements['documentTypeIn'].text
-			self.asset_params_ids_match_or = xml_element.elements['assetParamsIdsMatchOr'].text
-			self.asset_params_ids_match_and = xml_element.elements['assetParamsIdsMatchAnd'].text
+			if xml_element.elements['documentTypeEqual'] != nil
+				self.document_type_equal = xml_element.elements['documentTypeEqual'].text
+			end
+			if xml_element.elements['documentTypeIn'] != nil
+				self.document_type_in = xml_element.elements['documentTypeIn'].text
+			end
+			if xml_element.elements['assetParamsIdsMatchOr'] != nil
+				self.asset_params_ids_match_or = xml_element.elements['assetParamsIdsMatchOr'].text
+			end
+			if xml_element.elements['assetParamsIdsMatchAnd'] != nil
+				self.asset_params_ids_match_and = xml_element.elements['assetParamsIdsMatchAnd'].text
+			end
 		end
 
 	end
@@ -442,27 +486,13 @@ module Kaltura
 
 
 	# Document service lets you upload and manage document files
-	#  
 	class KalturaDocumentsService < KalturaServiceBase
 		def initialize(client)
 			super(client)
 		end
 
-		# Add new document entry after the specific document file was uploaded and the upload token id exists
-		# 	 
-		def add_from_uploaded_file(document_entry, upload_token_id)
-			kparams = {}
-			client.add_param(kparams, 'documentEntry', document_entry)
-			client.add_param(kparams, 'uploadTokenId', upload_token_id)
-			client.queue_service_action_call('document_documents', 'addFromUploadedFile', 'KalturaDocumentEntry', kparams)
-			if (client.is_multirequest)
-				return nil
-			end
-			return client.do_queue()
-		end
-
 		# Copy entry into new entry
-		# 	 
+		# @return [KalturaDocumentEntry]
 		def add_from_entry(source_entry_id, document_entry=KalturaNotImplemented, source_flavor_params_id=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'sourceEntryId', source_entry_id)
@@ -476,7 +506,7 @@ module Kaltura
 		end
 
 		# Copy flavor asset into new entry
-		# 	 
+		# @return [KalturaDocumentEntry]
 		def add_from_flavor_asset(source_flavor_asset_id, document_entry=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'sourceFlavorAssetId', source_flavor_asset_id)
@@ -488,91 +518,102 @@ module Kaltura
 			return client.do_queue()
 		end
 
-		# Convert entry
-		# 	 
-		def convert(entry_id, conversion_profile_id=KalturaNotImplemented, dynamic_conversion_attributes=KalturaNotImplemented)
+		# Add new document entry after the specific document file was uploaded and the upload token id exists
+		# @return [KalturaDocumentEntry]
+		def add_from_uploaded_file(document_entry, upload_token_id)
 			kparams = {}
-			client.add_param(kparams, 'entryId', entry_id)
-			client.add_param(kparams, 'conversionProfileId', conversion_profile_id)
-			client.add_param(kparams, 'dynamicConversionAttributes', dynamic_conversion_attributes)
-			client.queue_service_action_call('document_documents', 'convert', 'bigint', kparams)
+			client.add_param(kparams, 'documentEntry', document_entry)
+			client.add_param(kparams, 'uploadTokenId', upload_token_id)
+			client.queue_service_action_call('document_documents', 'addFromUploadedFile', 'KalturaDocumentEntry', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Get document entry by ID.
-		# 	 
-		def get(entry_id, version=-1)
+		# Approves document replacement
+		# @return [KalturaDocumentEntry]
+		def approve_replace(entry_id)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
-			client.add_param(kparams, 'version', version)
-			client.queue_service_action_call('document_documents', 'get', 'KalturaDocumentEntry', kparams)
+			client.queue_service_action_call('document_documents', 'approveReplace', 'KalturaDocumentEntry', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Update document entry. Only the properties that were set will be updated.
-		# 	 
-		def update(entry_id, document_entry)
+		# Cancels document replacement
+		# @return [KalturaDocumentEntry]
+		def cancel_replace(entry_id)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
-			client.add_param(kparams, 'documentEntry', document_entry)
-			client.queue_service_action_call('document_documents', 'update', 'KalturaDocumentEntry', kparams)
+			client.queue_service_action_call('document_documents', 'cancelReplace', 'KalturaDocumentEntry', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Delete a document entry.
-		# 	 
-		def delete(entry_id)
+		# Convert entry
+		# @return [bigint]
+		def convert(entry_id, conversion_profile_id=KalturaNotImplemented, dynamic_conversion_attributes=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
-			client.queue_service_action_call('document_documents', 'delete', '', kparams)
+			client.add_param(kparams, 'conversionProfileId', conversion_profile_id)
+			client.add_param(kparams, 'dynamicConversionAttributes', dynamic_conversion_attributes)
+			client.queue_service_action_call('document_documents', 'convert', 'bigint', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# List document entries by filter with paging support.
-		# 	 
-		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+		# This will queue a batch job for converting the document file to swf
+		# 	 Returns the URL where the new swf will be available
+		# @return [string]
+		def convert_ppt_to_swf(entry_id)
 			kparams = {}
-			client.add_param(kparams, 'filter', filter)
-			client.add_param(kparams, 'pager', pager)
-			client.queue_service_action_call('document_documents', 'list', 'KalturaDocumentListResponse', kparams)
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('document_documents', 'convertPptToSwf', 'string', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Upload a document file to Kaltura, then the file can be used to create a document entry. 
-		# 	 
-		def upload(file_data)
+		# Delete a document entry.
+		# @return []
+		def delete(entry_id)
 			kparams = {}
-			kfiles = {}
-			client.add_param(kfiles, 'fileData', file_data)
-			client.queue_service_action_call('document_documents', 'upload', 'string', kparams, kfiles)
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('document_documents', 'delete', '', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# This will queue a batch job for converting the document file to swf
-		# 	 Returns the URL where the new swf will be available 
-		# 	 
-		def convert_ppt_to_swf(entry_id)
+		# Get document entry by ID.
+		# @return [KalturaDocumentEntry]
+		def get(entry_id, version=-1)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
-			client.queue_service_action_call('document_documents', 'convertPptToSwf', 'string', kparams)
+			client.add_param(kparams, 'version', version)
+			client.queue_service_action_call('document_documents', 'get', 'KalturaDocumentEntry', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# List document entries by filter with paging support.
+		# @return [KalturaDocumentListResponse]
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'pager', pager)
+			client.queue_service_action_call('document_documents', 'list', 'KalturaDocumentListResponse', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
@@ -580,7 +621,7 @@ module Kaltura
 		end
 
 		# Serves the file content
-		# 	 
+		# @return [file]
 		def serve(entry_id, flavor_asset_id=KalturaNotImplemented, force_proxy=false)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
@@ -591,7 +632,7 @@ module Kaltura
 		end
 
 		# Serves the file content
-		# 	 
+		# @return [file]
 		def serve_by_flavor_params_id(entry_id, flavor_params_id=KalturaNotImplemented, force_proxy=false)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
@@ -601,38 +642,40 @@ module Kaltura
 			return client.get_serve_url()
 		end
 
-		# Replace content associated with the given document entry.
-		# 	 
-		def update_content(entry_id, resource, conversion_profile_id=KalturaNotImplemented)
+		# Update document entry. Only the properties that were set will be updated.
+		# @return [KalturaDocumentEntry]
+		def update(entry_id, document_entry)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
-			client.add_param(kparams, 'resource', resource)
-			client.add_param(kparams, 'conversionProfileId', conversion_profile_id)
-			client.queue_service_action_call('document_documents', 'updateContent', 'KalturaDocumentEntry', kparams)
+			client.add_param(kparams, 'documentEntry', document_entry)
+			client.queue_service_action_call('document_documents', 'update', 'KalturaDocumentEntry', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Approves document replacement
-		# 	 
-		def approve_replace(entry_id)
+		# Replace content associated with the given document entry.
+		# @return [KalturaDocumentEntry]
+		def update_content(entry_id, resource, conversion_profile_id=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'entryId', entry_id)
-			client.queue_service_action_call('document_documents', 'approveReplace', 'KalturaDocumentEntry', kparams)
+			client.add_param(kparams, 'resource', resource)
+			client.add_param(kparams, 'conversionProfileId', conversion_profile_id)
+			client.queue_service_action_call('document_documents', 'updateContent', 'KalturaDocumentEntry', kparams)
 			if (client.is_multirequest)
 				return nil
 			end
 			return client.do_queue()
 		end
 
-		# Cancels document replacement
-		# 	 
-		def cancel_replace(entry_id)
+		# Upload a document file to Kaltura, then the file can be used to create a document entry.
+		# @return [string]
+		def upload(file_data)
 			kparams = {}
-			client.add_param(kparams, 'entryId', entry_id)
-			client.queue_service_action_call('document_documents', 'cancelReplace', 'KalturaDocumentEntry', kparams)
+			kfiles = {}
+			client.add_param(kfiles, 'fileData', file_data)
+			client.queue_service_action_call('document_documents', 'upload', 'string', kparams, kfiles)
 			if (client.is_multirequest)
 				return nil
 			end