velir_kaltura-ruby 0.4.5 → 0.4.6

data/Rakefile

@@ -10,8 +10,8 @@ begin
     gem.email = "patrick.robertson@velir.com"
     gem.homepage = "http://github.com/Velir/kaltura-ruby"
     gem.authors = ["Patrick Robertson"]
-    gem.add_dependency('activesupport', '<=2.3.8')
-    gem.add_dependency('activeresource','<=2.3.8')
+    gem.add_dependency('activesupport', '>=2.3.8')
+    gem.add_dependency('activeresource','>=2.3.8')
     gem.add_dependency('json')
     gem.add_dependency('rest-client', '>= 1.5.1')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 4
-:patch: 5
+:patch: 6
 :build: 

data/lib/kaltura/kaltura_client.rb

@@ -628,8 +628,16 @@ module Kaltura
 
 	end
 
+  ##
+  # The LiveStreamAdminEntry object is what the LiveStreamService utilizes to create streams.
+  #
+  # It is important to note that the fields media_type, and the encoding fields are necessary
+  # to create a LiveStream on the Kaltura server.
+  ##
 	class LiveStreamAdminEntry < LiveStreamEntry
+	  # This field is required to create a new LiveStream on the Kaltura server.
 		attr_accessor :encoding_ip1
+		# This field is required to create a new LiveStream on the Kaltura server.
 		attr_accessor :encoding_ip2
 		attr_accessor :stream_password
 		attr_accessor :stream_username

data/lib/kaltura/service/access_control_service.rb

@@ -1,19 +1,74 @@
 module Kaltura
   module Service
+    ##
+    # AccessControlService is responsible for adding and managing access control profiles.
+    # 
+    # @example Add a new access control profile:
+    #   access_control = Kaltura::AccessControl.new
+    #   access_control.name = "Restrictions"
+    #   client.access_control_service.add(access_control)
+    #
+    # @example Retrive an access control profile:
+    #   client.access_control_service.get(5)
+    #
+    # @example Update an existing access control profile:
+    #   new_access_control = Kaltura::AccessControl.new
+    #   new_access_control.description = "making the world safer one profile at a time."
+    #   client.access_control_service.update(5,new_access_control)
+    #
+    # @example Delete an eisting access control profile:
+    #   client.access_control_service.delete(5)
+    #
+    # @example List up to 10 Access Control Profiles ordered by name:
+    #   filter = Kaltura::Filter::AccessControlFilter.new
+    #   filter.order_by('name')
+    #   pager = Kaltura::FilterPager.new
+    #   pager.page_size = 10
+    #   client.access_control_service.list(filter,pager)
+    ##
     class AccessControlService < BaseService
-
+      
+      ##
+      # Adds a new Access Control Profile.
+      #
+      # @param [Kaltura::AccessControl] access_control The new profile to add.
+      # 
+      # @return [Kaltura::AccessControl] Returns the AccessControl object if the action was successful.  Useful for knowing the id of the object.
+      #
+      # @raise [Kaltura::APIError] default Kaltura error messages.
+      ##
   		def add(access_control)
   			kparams = {}
   			client.add_param(kparams, 'accessControl', access_control)
   			perform_request('accessControl','add',kparams,false)
   		end
-
+      
+      ##
+      # Retrieves an Access Control Profile by ID.
+      #
+      # @param [Integer] id The Access Control Profile ID.
+      #
+      # @return [Kaltura::AccessControl]  Returns the AccessControl object if the action was successful.
+      #
+      # @raise [Kaltura::APIError] default Kaltura error messages.
+      ##
   		def get(id)
   			kparams = {}
   			client.add_param(kparams, 'id', id)
   			perform_request('accessControl','get',kparams,false)
   		end
 
+      ##
+      # Updates an Access Control Profile by ID. Like other API update service calls, you instantiate a new AccessControl object,
+      # perform your changes to the new object, and use that as the second parameter.  There are no required parameters.
+      #
+      # @param [Integer] id The Access Control Profile ID.
+      # @param [Kaltura::AccessControl] access_control A newly instantiated AccessControl object that has the only the attributes you want to edit.  
+      # 
+      # @return [Kaltura:AccessControl] Returns the updated Access Control profile if the action was successful.
+      #
+      # @raise [Kaltura::APIError] default Kaltura error messages.
+      ##
   		def update(id, access_control)
   			kparams = {}
   			client.add_param(kparams, 'id', id)
@@ -21,12 +76,29 @@ module Kaltura
   			perform_request('accessControl','update',kparams,false)
   		end
 
+      ##
+      # Deletes an Access Control Profile by ID.
+      #
+      # @param [Integer] id The Access Control Profile ID.
+      # 
+      # @return [nil] returns nothing
+      # 
+      # @raise [Kaltura::APIError] default Kaltura error messages.
+      ##
   		def delete(id)
   			kparams = {}
   			client.add_param(kparams, 'id', id)
   			perform_request('accessControl','delete',kparams,false)
   		end
-
+      
+      ##
+      # Lists Access Control Profiles given an optional filter and pager.
+      #
+      # @param [Kaltura::Filter::AccessControlFilter] filter
+      # @param [Kaltura::FilterPager] pager
+      # 
+      # @return [Kaltura::Response::AccessControlListResponse] Returns an equivalent response to Kaltura::BaseResponse.
+      ##
   		def list(filter=nil, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)

data/lib/kaltura/service/admin_user_service.rb

@@ -1,7 +1,29 @@
 module Kaltura
   module Service
+    ##
+    # AdminUserService manages details for the administrative KMC user.
+    #
+    # @example Setting a new Admin password:
+    #   client.admin_user_service.update_password('pat@velir.com','OMGWTFPASSWRD',,'PASSWRDBBQ')
+    # @example Setting a new Admin password/email:
+    #   client.admin_user_service.update_password('pat@velir.com','OMGWTFPASSWRD','patrick@velir.com','PASSWRDBBQ')
+    # @example Resetting a admins password:
+    #   client.admin_user_service.reset_password('pat@velir.com')
+    ##
     class AdminUserService < BaseService
-
+      
+      ##
+      # Updates the admin password and email.
+      #
+      # @param [String] email Administrative user email.
+      # @param [String] password Current administrative user password.
+      # @param [String] new_email
+      # 
+      # @return [Kaltura::AdminUser] The administrative user updated.
+      #
+      # @raise [Kaltura::APIError] Returns two additional error messages: INVALID_FIELD_VALUE when a field isn't valid
+      #   and ADMIN_KUSER_WRONG_OLD_PASSWORD when the old password is wrong.
+      ##
   		def update_password(email, password, new_email='', new_password='')
   			kparams = {}
   			client.add_param(kparams, 'email', email)
@@ -11,12 +33,31 @@ module Kaltura
   			perform_request('adminUser','updatePassword',kparams,false)
   		end
 
+      ##
+      # Resets admins user password and sends the new one to the admins' email address.
+      #
+      # @param [String] email The admin's email address.
+      #
+      # @return [nil] returns nil.
+      # 
+      # @raise [Kaltura::APIError] raises default Kaltura errors.
+      ##
   		def reset_password(email)
   			kparams = {}
   			client.add_param(kparams, 'email', email)
   			perform_request('adminUser','resetPassword',kparams,false)
   		end
-
+      
+      ##
+      # Gets an admin session using the admin email and password.  This method is used for the KMC login.
+      #
+      # @param [String] email The admin's email address.
+      # @param [String] password The admin's password.
+      #
+      # @return [String] User session string.
+      #
+      # @raise [Kaltura::APIError] raises default Kaltura errors in addition to ADMIN_KUSER_NOT_FOUND if the user isn't found.
+      ##
   		def login(email, password)
   			kparams = {}
   			client.add_param(kparams, 'email', email)

data/lib/kaltura/service/base_entry_service.rb

@@ -1,7 +1,50 @@
 module Kaltura
   module Service
+    ##
+    # BaseEntryService is a service for generic entries.  If you do not know what type of media you are working with,
+    # this is a good service to use.  You need to know what media type you are working with for MediaService.
+    #
+    # @example Retrieve a base entry:
+    #   client.base_entry_service.get('1_qua324a')
+    #
+    # @example Upload a new entry:
+    #   upload_file = File.open("/path/to/media_file")
+    #   upload_token = client.base_entry_service.upload(upload_file)
+    #   base_entry = Kaltura::BaseEntry.new
+    #   base_entry.name = "WAFFLES ARE MY FRIEND"
+    #   client.base_entry_service.add_from_uploaded_file(base_entry,upload_token)
+    #
+    # @example Update an existing entry:
+    #   update_entry = Kaltura::BaseEntry.new
+    #   update_entry.description = "Pancakes are lame yo."
+    #   client.base_entry_service.update('1_qua324a',update_entry)
+    #
+    # @example Delete an existing entry:
+    #   client.base_entry_service.delete('1_qua324a')
+    #
+    # @example Update an Entry thumbnail via file upload:
+    #   thumbnail_file = File.open('/path/to/thumbnail_file')
+    #   client.base_entry_service.update_thumbnail_from_jpeg('1_qua324a',thumbnail_file)
+    #   
+    # @example Update an entry thumbnail from a url:
+    #   client.base_entry_service.update_thumbnail_from_url('1_qua324a','http://twitter.com/waffles/waffletastic.jpg')
+    #
+    # @example Update an entry thumbnail from another entry:
+    #   client.base_entry_service.update_thumbnail_from_source_entry('1_qua324a','0_k24aj1b',5)
+    ##
     class BaseEntryService < BaseService
-
+      
+      ##
+      # Generic add entry using an uploaded file, should be used when the uploaded entry type is not known.
+      #
+      # @param [Kaltura::BaseEntry] entry A newly instantiated BaseEntry object filled in with appropriate fields.
+      # @param [String] upload_token_id The upload token from the upload() method.
+      # @param [Kaltura::Constants::Entry::Type] type The type of entry.  This should be defaulted.  Otherwise use the MediaService.
+      #
+      # @return [Kaltura::BaseEntry] Returns a Kaltura Entry.  This is helpful to retrieve the entry_id.
+      #
+      # @raise [Kaltura::APIError] Default Kaltura errors.
+      ##
   		def add_from_uploaded_file(entry, upload_token_id, type=-1)
   			kparams = {}
   			client.add_param(kparams, 'entry', entry)
@@ -10,65 +53,168 @@ module Kaltura
   			perform_request('baseEntry','addFromUploadedFile',kparams,false)
   		end
 
+      ##
+      # Gets a base entry by ID.
+      #
+      # @param [String] entry_id Kaltura entry.
+      # @param [Integer] version Version of the entry.
+      #
+      # @return [Kaltura::BaseEntry] The requested Entry.
+      #
+      # @raise [Kaltura::APIError] Default Kaltura errors.
+      ##
   		def get(entry_id, version=-1)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			client.add_param(kparams, 'version', version)
   			perform_request('baseEntry','get',kparams,false)
   		end
-
+      
+      ##
+      # Updates a base entry.  It is best to instantiate a new base entry for the second parameter and initilize
+      # those fields for the changes you want to change instead of using an existing entry object.
+      #
+      # @param [String] entry_id The Kaltura entry to be updated.
+      # @param [Kaltura::BaseEntry] base_entry A BaseEntry object with fields populated that you wish to change.
+      #
+      # @return [Kaltura::BaseEntry] Returns the Entry defined by entry_id with the updated fields.
+      #
+      # @raise [Kaltura::APIError] raises "ENTRY_ID_NOT_FOUND" if the entry_id isn't found in addition to default errors.
+      ##
   		def update(entry_id, base_entry)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			client.add_param(kparams, 'baseEntry', base_entry)
   			perform_request('baseEntry','update',kparams,false)
   		end
-
+      
+      ##
+      # Retrieves an array of BaseEntries when provided a comma seperated list of entry_id's.
+      #
+      # @param [String] entry_ids A comma delimited list of Kaltura entry_id's.
+      #
+      # @return [Array] Returns an array of Entries, based upon their format.
+      # 
+      # @raise [Kaltura::APIError] Default Kaltura errors.
+      ##
   		def get_by_ids(entry_ids)
   			kparams = {}
   			client.add_param(kparams, 'entryIds', entry_ids)
   			perform_request('baseEntry','getByIds',kparams,false)
   		end
 
+      ##
+      # Deletes the specified Kaltura Entry.
+      #
+      # @param [String] entry_id The Kaltura entry to be deleted.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Default Kaltura errors.
+      ##
   		def delete(entry_id)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			perform_request('baseEntry','delete',kparams,false)
   		end
-
+      
+      ##
+      # Lists base entries by the filter with paging support.
+      #
+      # @param [Kaltura::Filter::BaseEntryFilter] filter
+      # @param [Kaltura::FilterPager] pager
+      #
+      # @return [Kaltura::Response::BaseEntryListResponse] wrapper for Kaltura::Response::BaseResponse.
+      # 
+      # @raise [Kaltura::APIError] Default Kaltura errors.
+      ##
   		def list(filter=nil, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)
   			client.add_param(kparams, 'pager', pager)
   			perform_request('baseEntry','list',kparams,false)
   		end
-
+      
+      ##
+      # Returns a count based on a specified base entry filter.
+      #
+      # @param [Kaltura::Filter::BaseEntryFilter] filter
+      # 
+      # @return [Integer] Number of base entries within the filter.
+      # 
+      # @raise [Kaltura::APIError] Default Kaltura errors.
+      ##
   		def count(filter=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)
   			perform_request('baseEntry','count',kparams,false)
   		end
 
+      ##
+      # Uploads a file to the Kaltura server and returns a token to be used to create a Kaltura entry.
+      #
+      # @param [File] file_data The file to upload to Kaltura.
+      #
+      # @return [String] The file upload_token_id to be used by entry adding methods.
+      # 
+      # @raise [Kaltura::APIError] Default Kaltura errors.
+      ##
   		def upload(file_data)
   			kparams = {}
   			client.add_param(kparams, 'fileData', file_data)
   			perform_request('baseEntry','upload',kparams,false)
   		end
 
+      ##
+      # Updates an entries thumbnail using a raw jpeg file.
+      #
+      # @param [String] entry_id The Kaltura entry.
+      # @param [File] file_data The MIME type of 'image/jpg' file to be used as the entries thumbnail.
+      #   This will update the entries version and the thumbnail's version.
+      #
+      # @return [Kaltura::BaseEntry] The updated Kaltura entry.  The primary change will be a version bump.
+      # 
+      # @raise [Kaltura::APIError] Will raise 'PERMISSION_DENIED_TO_UPDATE_ENTRY' 
+      #   if the user session doesn't have permissions to edit this particular entry.
+      ##
   		def update_thumbnail_jpeg(entry_id, file_data)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			client.add_param(kparams, 'fileData', file_data)
   			perform_request('baseEntry','updateThumbnailJpeg',kparams,false)
   		end
-
+      ##
+      # Updates an entries thumbnail using a valid URL.
+      #
+      # @param [String] entry_id The Kaltura entry.
+      # @param [File] url The URL to pull the thumbnail from.
+      #   This will update the entries version and the thumbnail's version.
+      #
+      # @return [Kaltura::BaseEntry] The updated Kaltura entry.  The primary change will be a version bump.
+      # 
+      # @raise [Kaltura::APIError] Will raise 'PERMISSION_DENIED_TO_UPDATE_ENTRY' 
+      #   if the user session doesn't have permissions to edit this particular entry.
+      ##
   		def update_thumbnail_from_url(entry_id, url)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			client.add_param(kparams, 'url', url)
   			perform_request('baseEntry','updateThumbnailFromUrl',kparams,false)
   		end
-
+      
+      ##
+      # Updates the entries thumbnail from another entry given a specified time offset.
+      # This is one truly odd API call.
+      #
+      # @param [String] entry_id The Kaltura entry to be changed.
+      # @param [String] source_entry_id The Kaltura entry providing the change.
+      # @param [Integer] time_offset The time in seconds to offset the source_entry_id thumbnail by.
+      # 
+      # @return [Kaltura::BaseEntry] The updated Kaltura entry.  The primary change will be a version bump.
+      # 
+      # @raise [Kaltura::APIError] Will raise 'PERMISSION_DENIED_TO_UPDATE_ENTRY' 
+      #   if the user session doesn't have permissions to edit this particular entry.
+      ##
   		def update_thumbnail_from_source_entry(entry_id, source_entry_id, time_offset)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
@@ -77,31 +223,84 @@ module Kaltura
   			perform_request('baseEntry','updateThumbnailFromSourceEntry',kparams,false)
   		end
 
+      ##
+      # Flags an inappropriate Kaltura entry for moderation.
+      # The entry ID is provided in the moderation_flag, so it isn't blatently obvious which entry you are
+      # interacting with.  The method also outputs nothing, so success/failure is more difficult than necessary
+      # to track.
+      #
+      # @param [Kaltura::ModerationFlag] moderation_flag The Kaltura Entry being flagged is hidden down in the field 'flagged_entry_id'.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] raises "ENTRY_ID_NOT_FOUND" if the entry_id isn't found in addition to default errors.
+      ##
   		def flag(moderation_flag)
   			kparams = {}
   			client.add_param(kparams, 'moderationFlag', moderation_flag)
   			perform_request('baseEntry','flag',kparams,false)
   		end
 
+      ##
+      # Rejects a Kaltura entry and marks any pending flags as moderated.
+      # This makes the entry unplayable and is a much more sane method to flag content than the flag method.
+      #
+      # @param [String] entry_id The Kaltura entry to reject.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] raises "ENTRY_ID_NOT_FOUND" if the entry_id isn't found in addition to default errors.      
+      ##
   		def reject(entry_id)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			perform_request('baseEntry','reject',kparams,false)
   		end
 
+      ##
+      # Approves an entry and marks any pending flags as moderated.  
+      # This makes the entry playable.
+      #
+      # @param [String] entry_id The Kaltura entry to approve.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] raises "ENTRY_ID_NOT_FOUND" if the entry_id isn't found in addition to default errors.
+      ##
   		def approve(entry_id)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			perform_request('baseEntry','approve',kparams,false)
   		end
 
+      ##
+      # Lists all pending moderation flags for the specified entry.
+      #
+      # @param [String] entry_id The Kaltura entry.
+      # @param [Kaltura::FilterPager] pager An optional pager to use for a large list of pending moderation flags.
+      #
+      # @return [Kaltura::Response::ModerationFlagListResponse] Wrapper for Kaltura::BaseResponse.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
   		def list_flags(entry_id, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			client.add_param(kparams, 'pager', pager)
   			perform_request('baseEntry','listFlags',kparams,false)
   		end
-
+      
+      ##
+      # Anonymously ranks an entry.
+      # There is no validation done on duplicate rankings.
+      #
+      # @param [String] entry_id The Kaltura entry to rank.
+      # @param [Integer] rank The rank to assign.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
   		def anonymous_rank(entry_id, rank)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
@@ -109,6 +308,18 @@ module Kaltura
   			perform_request('baseEntry','anonymousRank',kparams,false)
   		end
 
+      ##
+      # Retrieves the context data from a Kaltura entry.  This is not documented in the API.
+      # I'd be cautious about actually using this method.
+      #
+      # @param [String] entry_id The Kaltura entry.
+      # @param [Kaltura::EntryContextDataParams] context_data_params The only field not inherited from Kaltura::ObjectBase
+      #   is referrer, so I imagine that is what you should set.
+      #
+      # @return [Kaltura::EntryConextDataResult] Returns some context info, including is the entry restricted by country or session.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
   		def get_context_data(entry_id, context_data_params)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)

data/lib/kaltura/service/base_service.rb

@@ -1,12 +1,34 @@
 module Kaltura
   module Service
+    ##
+    # Base Service is a method extraction refactoring performed on the Service module for the Velir 
+    # branch of the kaltura-ruby library.  Previously perform_request existed in each method of each
+    # service.
+    #
+    # @author Patrick Robertson
+    ##
     class BaseService
     	attr_accessor :client
 
     	def initialize(client)
     		@client = client
     	end
-
+      
+      ##
+      # Enqueues the service class, action, and paramters onto the client object and then
+      # informs the client object to perform pop an action off the queue.
+      #
+      # @param [String] service_class The particular class within the Service module.  
+      #   This translates to a paramter of service=service_class on the http request.
+      # @param [String] service_action The action method performed by the service_class.
+      #   This translates to a parameter of action=service_action on the http request.
+      # @param [Boolean] allow_multirequest I've never seen this implemented.  It's around
+      #   just in case though.
+      # 
+      # @return [Object] Returns the result of the request.
+      #
+      # @raise [Kaltura::APIError] Raises the Kaltura error of the request.
+      ## 
     	def perform_request(service_class,service_action,paramters,allow_multirequest=true)
         if allow_multirequest == false && client.is_multirequest
           return nil

data/lib/kaltura/service/bulk_upload_service.rb

@@ -1,7 +1,39 @@
 module Kaltura
   module Service
+    ##
+    # The Bulk upload service is used to upload and manage bulk uploads using CSV files.
+    # This service is available through the KMC and typically would be a one-off, 
+    # though you could choose to use it with a web application.
+    #
+    # @example Create a new bulk upload job:
+    #   csv_file = File.open('/path/to/csv_file/')
+    #   client.bulk_upload_service.add('12141313',csv_file)
+    #
+    # @example Retrieve a bulk upload status:
+    #   status = client.bulk_upload_service.get('124').status
+    #
+    # @example List all bulk upload jobs:
+    #   pager = Kaltura::FilterPager.new
+    #   pager.page_size = 100000000
+    #   client.bulk_upload_service.list(pager)
+    ##
     class BulkUploadService < BaseService
-
+      
+      ##
+      # Adds a new bulk upload batch job.
+      # The conversion profile ID can be either specified in the API or in the CSV file itself.
+      # The attribute in the CSV overrides the API ID.  The partner's default conversion profile 
+      # will be used if no ID is provided.
+      #
+      # @param [Integer] conversion_profile_id This is the conversion profile to create flavors for each entry from.
+      #   If there is a conversion profile defined in the file, this paramter will be overriden.
+      # @param [File] csv_file_data The CSV file used to batch upload.
+      #
+      # @return [Kaltura::BulkUpload] A Bulk upload object contains useful information regarding the batch upload status.
+      #   It would be advised you store the ID of this object somewhere for later retrieval.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
   		def add(conversion_profile_id, csv_file_data)
   			kparams = {}
   			client.add_param(kparams, 'conversionProfileId', conversion_profile_id)
@@ -9,12 +41,30 @@ module Kaltura
   			perform_request('bulkUpload','add',kparams,false)
   		end
 
+      ##
+      # Retrieves a BulkUpload object.
+      #
+      # @param [Integer] id The ID of the BulkUpload object.
+      #
+      # @return [Kaltura::BulkUpload] The BulkUpload object requested.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
   		def get(id)
   			kparams = {}
   			client.add_param(kparams, 'id', id)
   			perform_request('bulkUpload','get',kparams,false)
   		end
 
+      ##
+      # Lists bulk upload batch jobs given a pager index and size.
+      #
+      # @param [Kaltura::FilterPager] pager Default Kaltura pager object.
+      #
+      # @return [Kaltura::Response::BulkUploadListResponse] Wrapper for BaseResponse.
+      # 
+      # @return [Kaltura::APIError] Raises default Kaltura errors.
+      ## 
   		def list(pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'pager', pager)