kaltura-ruby-client 1.0

data/lib/kaltura_plugins/kaltura_multi_centers_client_plugin.rb

@@ -0,0 +1,45 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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 KalturaFileSyncImportJobData < KalturaJobData
+		attr_accessor :source_url
+		attr_accessor :filesync_id
+		attr_accessor :tmp_file_path
+		attr_accessor :dest_file_path
+		attr_accessor :file_size
+
+		def file_size=(val)
+			@file_size = val.to_i
+		end
+	end
+
+
+end

data/lib/kaltura_plugins/kaltura_short_link_client_plugin.rb

@@ -0,0 +1,231 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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 KalturaShortLinkStatus
+		DISABLED = 1
+		ENABLED = 2
+		DELETED = 3
+	end
+
+	class KalturaShortLinkOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		EXPIRES_AT_ASC = "+expiresAt"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		EXPIRES_AT_DESC = "-expiresAt"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	class KalturaShortLink < KalturaObjectBase
+		attr_accessor :id
+		attr_accessor :created_at
+		attr_accessor :updated_at
+		attr_accessor :expires_at
+		attr_accessor :partner_id
+		attr_accessor :user_id
+		attr_accessor :name
+		attr_accessor :system_name
+		attr_accessor :full_url
+		attr_accessor :status
+
+		def id=(val)
+			@id = val.to_i
+		end
+		def created_at=(val)
+			@created_at = val.to_i
+		end
+		def updated_at=(val)
+			@updated_at = val.to_i
+		end
+		def expires_at=(val)
+			@expires_at = val.to_i
+		end
+		def partner_id=(val)
+			@partner_id = val.to_i
+		end
+		def status=(val)
+			@status = val.to_i
+		end
+	end
+
+	class KalturaShortLinkListResponse < KalturaObjectBase
+		attr_accessor :objects
+		attr_accessor :total_count
+
+		def total_count=(val)
+			@total_count = val.to_i
+		end
+	end
+
+	class KalturaShortLinkBaseFilter < KalturaFilter
+		attr_accessor :id_equal
+		attr_accessor :id_in
+		attr_accessor :created_at_greater_than_or_equal
+		attr_accessor :created_at_less_than_or_equal
+		attr_accessor :updated_at_greater_than_or_equal
+		attr_accessor :updated_at_less_than_or_equal
+		attr_accessor :expires_at_greater_than_or_equal
+		attr_accessor :expires_at_less_than_or_equal
+		attr_accessor :partner_id_equal
+		attr_accessor :partner_id_in
+		attr_accessor :user_id_equal
+		attr_accessor :user_id_in
+		attr_accessor :system_name_equal
+		attr_accessor :system_name_in
+		attr_accessor :status_equal
+		attr_accessor :status_in
+
+		def id_equal=(val)
+			@id_equal = val.to_i
+		end
+		def created_at_greater_than_or_equal=(val)
+			@created_at_greater_than_or_equal = val.to_i
+		end
+		def created_at_less_than_or_equal=(val)
+			@created_at_less_than_or_equal = val.to_i
+		end
+		def updated_at_greater_than_or_equal=(val)
+			@updated_at_greater_than_or_equal = val.to_i
+		end
+		def updated_at_less_than_or_equal=(val)
+			@updated_at_less_than_or_equal = val.to_i
+		end
+		def expires_at_greater_than_or_equal=(val)
+			@expires_at_greater_than_or_equal = val.to_i
+		end
+		def expires_at_less_than_or_equal=(val)
+			@expires_at_less_than_or_equal = val.to_i
+		end
+		def partner_id_equal=(val)
+			@partner_id_equal = val.to_i
+		end
+		def status_equal=(val)
+			@status_equal = val.to_i
+		end
+	end
+
+	class KalturaShortLinkFilter < KalturaShortLinkBaseFilter
+
+	end
+
+
+	# Short link service
+	#  
+	class KalturaShortLinkService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# List short link objects by filter and pager
+		# 	 
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter);
+			client.add_param(kparams, 'pager', pager);
+			client.queue_service_action_call('shortlink_shortlink', 'list', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Allows you to add a short link object
+		# 	 
+		def add(short_link)
+			kparams = {}
+			client.add_param(kparams, 'shortLink', short_link);
+			client.queue_service_action_call('shortlink_shortlink', 'add', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Retrieve an short link object by id
+		# 	 
+		def get(id)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.queue_service_action_call('shortlink_shortlink', 'get', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Update exisitng short link
+		# 	 
+		def update(id, short_link)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'shortLink', short_link);
+			client.queue_service_action_call('shortlink_shortlink', 'update', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Mark the short link as deleted
+		# 	 
+		def delete(id)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.queue_service_action_call('shortlink_shortlink', 'delete', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Serves short link
+		# 	 
+		def goto(id, proxy=false)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			# proxy the response instead of redirect
+			client.add_param(kparams, 'proxy', proxy);
+			client.queue_service_action_call('shortlink_shortlink', 'goto', kparams);
+			return client.get_serve_url();
+		end
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :short_link_service
+		def short_link_service
+			if (@short_link_service == nil)
+				@short_link_service = KalturaShortLinkService.new(self)
+			end
+			return @short_link_service
+		end
+	end
+
+end

data/lib/kaltura_plugins/kaltura_tag_search_client_plugin.rb

@@ -0,0 +1,145 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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 KalturaTag < KalturaObjectBase
+		attr_accessor :id
+		attr_accessor :tag
+		attr_accessor :tagged_object_type
+		attr_accessor :partner_id
+		attr_accessor :instance_count
+		attr_accessor :created_at
+		attr_accessor :updated_at
+
+		def id=(val)
+			@id = val.to_i
+		end
+		def partner_id=(val)
+			@partner_id = val.to_i
+		end
+		def instance_count=(val)
+			@instance_count = val.to_i
+		end
+		def created_at=(val)
+			@created_at = val.to_i
+		end
+		def updated_at=(val)
+			@updated_at = val.to_i
+		end
+	end
+
+	class KalturaTagListResponse < KalturaObjectBase
+		attr_accessor :objects
+		attr_accessor :total_count
+
+		def total_count=(val)
+			@total_count = val.to_i
+		end
+	end
+
+	class KalturaIndexTagsByPrivacyContextJobData < KalturaJobData
+		attr_accessor :changed_category_id
+		attr_accessor :deleted_privacy_contexts
+		attr_accessor :added_privacy_contexts
+
+		def changed_category_id=(val)
+			@changed_category_id = val.to_i
+		end
+	end
+
+	class KalturaTagFilter < KalturaFilter
+		attr_accessor :object_type_equal
+		attr_accessor :tag_equal
+		attr_accessor :tag_starts_with
+		attr_accessor :instance_count_equal
+		attr_accessor :instance_count_in
+
+		def instance_count_equal=(val)
+			@instance_count_equal = val.to_i
+		end
+		def instance_count_in=(val)
+			@instance_count_in = val.to_i
+		end
+	end
+
+
+	# Search object tags
+	#  
+	class KalturaTagService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		def search(tag_filter, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'tagFilter', tag_filter);
+			client.add_param(kparams, 'pager', pager);
+			client.queue_service_action_call('tagsearch_tag', 'search', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Action goes over all tags with instanceCount==0 and checks whether they need to be removed from the DB. Returns number of removed tags.
+		#      
+		def delete_pending()
+			kparams = {}
+			client.queue_service_action_call('tagsearch_tag', 'deletePending', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		def index_category_entry_tags(category_id, pc_to_decrement, pc_to_increment)
+			kparams = {}
+			client.add_param(kparams, 'categoryId', category_id);
+			client.add_param(kparams, 'pcToDecrement', pc_to_decrement);
+			client.add_param(kparams, 'pcToIncrement', pc_to_increment);
+			client.queue_service_action_call('tagsearch_tag', 'indexCategoryEntryTags', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :tag_service
+		def tag_service
+			if (@tag_service == nil)
+				@tag_service = KalturaTagService.new(self)
+			end
+			return @tag_service
+		end
+	end
+
+end

data/lib/kaltura_plugins/kaltura_var_console_client_plugin.rb

@@ -0,0 +1,238 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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 KalturaVarPartnerUsageItem < KalturaObjectBase
+		# Partner ID
+		# 	 
+		attr_accessor :partner_id
+		# Partner name
+		# 	 
+		attr_accessor :partner_name
+		# Partner status
+		# 	 
+		attr_accessor :partner_status
+		# Partner package
+		# 	 
+		attr_accessor :partner_package
+		# Partner creation date (Unix timestamp)
+		# 	 
+		attr_accessor :partner_created_at
+		# Number of player loads in the specific date range
+		# 	 
+		attr_accessor :views
+		# Number of plays in the specific date range
+		# 	 
+		attr_accessor :plays
+		# Number of new entries created during specific date range
+		# 	 
+		attr_accessor :entries_count
+		# Total number of entries
+		# 	 
+		attr_accessor :total_entries_count
+		# Number of new video entries created during specific date range
+		# 	 
+		attr_accessor :video_entries_count
+		# Number of new image entries created during specific date range
+		# 	 
+		attr_accessor :image_entries_count
+		# Number of new audio entries created during specific date range
+		# 	 
+		attr_accessor :audio_entries_count
+		# Number of new mix entries created during specific date range
+		# 	 
+		attr_accessor :mix_entries_count
+		# The total bandwidth usage during the given date range (in MB)
+		# 	 
+		attr_accessor :bandwidth
+		# The total storage consumption (in MB)
+		# 	 
+		attr_accessor :total_storage
+		# The added storage consumption (new uploads) during the given date range (in MB)
+		# 	 
+		attr_accessor :storage
+		# The deleted storage consumption (new uploads) during the given date range (in MB)
+		# 	 
+		attr_accessor :deleted_storage
+		# The peak amount of storage consumption during the given date range for the specific publisher
+		# 	 
+		attr_accessor :peak_storage
+		# The average amount of storage consumption during the given date range for the specific publisher
+		# 	 
+		attr_accessor :avg_storage
+		# The combined amount of bandwidth and storage consumed during the given date range for the specific publisher
+		# 	 
+		attr_accessor :combined_storage_bandwidth
+		# Amount of transcoding usage in MB
+		# 	 
+		attr_accessor :transcoding_usage
+		# TGhe date at which the report was taken - Unix Timestamp
+		# 	 
+		attr_accessor :date_id
+
+		def partner_id=(val)
+			@partner_id = val.to_i
+		end
+		def partner_status=(val)
+			@partner_status = val.to_i
+		end
+		def partner_package=(val)
+			@partner_package = val.to_i
+		end
+		def partner_created_at=(val)
+			@partner_created_at = val.to_i
+		end
+		def views=(val)
+			@views = val.to_i
+		end
+		def plays=(val)
+			@plays = val.to_i
+		end
+		def entries_count=(val)
+			@entries_count = val.to_i
+		end
+		def total_entries_count=(val)
+			@total_entries_count = val.to_i
+		end
+		def video_entries_count=(val)
+			@video_entries_count = val.to_i
+		end
+		def image_entries_count=(val)
+			@image_entries_count = val.to_i
+		end
+		def audio_entries_count=(val)
+			@audio_entries_count = val.to_i
+		end
+		def mix_entries_count=(val)
+			@mix_entries_count = val.to_i
+		end
+		def bandwidth=(val)
+			@bandwidth = val.to_f
+		end
+		def total_storage=(val)
+			@total_storage = val.to_f
+		end
+		def storage=(val)
+			@storage = val.to_f
+		end
+		def deleted_storage=(val)
+			@deleted_storage = val.to_f
+		end
+		def peak_storage=(val)
+			@peak_storage = val.to_f
+		end
+		def avg_storage=(val)
+			@avg_storage = val.to_f
+		end
+		def combined_storage_bandwidth=(val)
+			@combined_storage_bandwidth = val.to_f
+		end
+		def transcoding_usage=(val)
+			@transcoding_usage = val.to_f
+		end
+	end
+
+	class KalturaPartnerUsageListResponse < KalturaObjectBase
+		attr_accessor :total
+		attr_accessor :objects
+		attr_accessor :total_count
+
+		def total_count=(val)
+			@total_count = val.to_i
+		end
+	end
+
+	class KalturaVarPartnerUsageTotalItem < KalturaVarPartnerUsageItem
+
+	end
+
+	class KalturaVarConsolePartnerFilter < KalturaPartnerFilter
+		# Eq filter for the partner's group type
+		#      
+		attr_accessor :group_type_eq
+		# In filter for the partner's group type
+		#      
+		attr_accessor :group_type_in
+		# Filter for partner permissions- filter contains comma-separated string of permission names which the returned partners should have.
+		#      
+		attr_accessor :partner_permissions_exist
+
+		def group_type_eq=(val)
+			@group_type_eq = val.to_i
+		end
+	end
+
+
+	# Utility service for the Multi-publishers console
+	#  
+	class KalturaVarConsoleService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# Function which calulates partner usage of a group of a VAR's sub-publishers
+		#      
+		def get_partner_usage(partner_filter=KalturaNotImplemented, usage_filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'partnerFilter', partner_filter);
+			client.add_param(kparams, 'usageFilter', usage_filter);
+			client.add_param(kparams, 'pager', pager);
+			client.queue_service_action_call('varconsole_varconsole', 'getPartnerUsage', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+
+		# Function to change a sub-publisher's status
+		# 	 
+		def update_status(id, status)
+			kparams = {}
+			client.add_param(kparams, 'id', id);
+			client.add_param(kparams, 'status', status);
+			client.queue_service_action_call('varconsole_varconsole', 'updateStatus', kparams);
+			if (client.is_multirequest)
+				return nil;
+			end
+			return client.do_queue();
+		end
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :var_console_service
+		def var_console_service
+			if (@var_console_service == nil)
+				@var_console_service = KalturaVarConsoleService.new(self)
+			end
+			return @var_console_service
+		end
+	end
+
+end