goncalossilva_kaltura-ruby 0.4.8

data/lib/kaltura/service/email_ingestion_profile_service.rb

@@ -0,0 +1,122 @@
+module Kaltura
+  module Service
+    ##
+    # The Email Ingestion Profile Service allows you to manage email ingestion profile records.
+    ##
+    class EmailIngestionProfileService < BaseService
+      
+      ##
+      # Adds an email ingestion profile to the Kaltura Database.
+      #
+      # @param [Kaltura::EmailIngestionProfile] email_ip The email ingestion profile to add.
+      #
+      # @return [Kaltura::EmailIngestionProfile] Returns the email ingestion profile as stored on the DB.
+      #   It might be important to store either the email_address or ID fields for later.
+      #
+      # @raise [Kaltura::APIError] Raises 'EMAIL INGESTION PROFILE EMAIL EXISTS' if there is another profile using
+      #   the email address provided.
+      ##
+  		def add(email_ip)
+  			kparams = {}
+  			client.add_param(kparams, 'EmailIP', email_ip)
+  			perform_request('EmailIngestionProfile','add',kparams,false)
+  		end
+      
+      ##
+      # Retrieves an email ingestion profile by the email_address field.
+      #
+      # @param [String] email_address The email address to find the profile with.
+      #
+      # @return [Kaltura::EmailIngestionProfile] The requested email ingestion profile.
+      #
+      # @raise [Kaltura::APIError] Raises 'EMAIL INGESTION PROFILE NOT FOUND' if there isnt a profile with the
+      #   email address provided.
+      ##
+  		def get_by_email_address(email_address)
+  			kparams = {}
+  			client.add_param(kparams, 'emailAddress', email_address)
+  			perform_request('EmailIngestionProfile','getByEmailAddress',kparams,false)
+  		end
+
+      ##
+      # Retrieves an email ingestion profile by ID.
+      #
+      # @param [Integer] id The ID of the email ingestion profile to find.
+      #
+      # @return [Kaltura::EmailIngestionProfile] The requested email ingestion profile.
+      #
+      # @raise [Kaltura::APIError] Raises 'EMAIL INGESTION PROFILE NOT FOUND' if there isnt a profile with the
+      #   email address provided.
+      ##
+  		def get(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('EmailIngestionProfile','get',kparams,false)
+  		end
+
+      ##
+      # Updates an existing email ingestion profile.
+      # As with other update API actions it is a best practice to instantiate a new EmailIngestionProfile object
+      # and populate the fields with the fields you wish to change of the existing object.
+      #
+      # @param [Integer] id The ID of the email ingestion profile you wish to update.
+      # @param [Kaltura::EmailIngestionProfile] email_ip The newly instantiated email ingestion profile object
+      #  with the fields you wish to update.
+      #
+      # @return [Kaltura::EmailIngestionProfile] Returns the updated object with a new version.
+      #
+      # @raise [Kaltura::APIError] Raises 'EMAIL INGESTION PROFILE NOT FOUND' if there isnt a profile with the
+      #   email address provided.      
+      ##
+  		def update(id, email_ip)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			client.add_param(kparams, 'EmailIP', email_ip)
+  			perform_request('EmailIngestionProfile','update',kparams,false)
+  		end
+
+      ##
+      # Deletes an email ingestion profile by ID.
+      #
+      # @param [Integer] id The ID of the email ingestion profile to delete.
+      # 
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Raises 'EMAIL INGESTION PROFILE NOT FOUND' if there isnt a profile with the
+      #   email address provided.
+      ##
+  		def delete(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('EmailIngestionProfile','delete',kparams,false)
+  		end
+
+      ##
+      # Adds a Kaltura::MediaEntry from a email ingestion profile.
+      # I'm not entirely sure what the aim of this upload action is, rather than 
+      # using the media service itself.
+      #
+      # @param [Kaltura::MediaEntry] media_entry A newly instantiated media entry object that will be created
+      #   in the database.
+      # @param [String] upload_token_id The upload token provided by the media service's upload action.
+      # @param [Integer] email_profile_id The email ingestion profile ID.
+      # @param [String] from_address The email address the action is coming from?
+      # @param [String] email_msg_id The ID of the email message?
+      # 
+      # @return [Kaltura::MediaEntry] The newly created media entry as stored in the kaltura database.
+      #   It would be beneficial to store the entry_id of this object for later.
+      #
+      # @raise [Kaltura::APIError] Raises 'UPLOADED_FILE_NOT_FOUND_BY_TOKEN' when the upload token cannot be found.
+      ##
+  		def add_media_entry(media_entry, upload_token_id, email_prof_id, from_address, email_msg_id)
+  			kparams = {}
+  			client.add_param(kparams, 'mediaEntry', media_entry)
+  			client.add_param(kparams, 'uploadTokenId', upload_token_id)
+  			client.add_param(kparams, 'emailProfId', email_prof_id)
+  			client.add_param(kparams, 'fromAddress', from_address)
+  			client.add_param(kparams, 'emailMsgId', email_msg_id)
+  			perform_request('EmailIngestionProfile','addMediaEntry',kparams,false)
+  		end
+  	end #class EmailIngestionProfileService
+	end
+end

data/lib/kaltura/service/flavor_asset_service.rb

@@ -0,0 +1,155 @@
+module Kaltura
+  module Service
+    
+    ##
+    # The Flavor Asset Service allows you to retrieve information and invoke actions on flavor assets.
+    #
+    # @example Add a new flavor to a media entry:
+    #   client.flavor_asset_service.convert('1_qa32a3ax',22)
+    #
+    # @example Retrieve a flavor by flavor_id:
+    #   client.flavor_asset_service.get('0_as35a2r3a')
+    #
+    # @example Retrieve all flavors for a media entry:
+    #   client.flavor_asset_service.get_by_entry_id('1_qa32a3ax')
+    #      
+    # @example Retrieve all the web playable flavors for a media entry:
+    #   client.flavor_asset_service.get_web_playable_by_entry_id('1_qa32a3ax')
+    #
+    # @example Reconvert a specific Flavor:
+    #   client.flavor_asset_service.get('0_as35a2r3a')
+    #
+    # @example Delete a Flavor:
+    #   client.flavor_asset_service.delete('0_as35a2r3a')
+    #
+    # @example Retrieve a URL to download a specific flavor:
+    #   client.flavor_asset_service.get_download_url('0_as35a2r3a')
+    #
+    ##
+    class FlavorAssetService < BaseService
+
+      ##
+      # Retrieves an individual flavor asset by ID.
+      #
+      # @param [String] id A flavor asset ID closely resembles an entry_id as Kaltura flavors are 
+      #   very close in nature to entries.
+      #
+      # @return [Kaltura::FlavorAsset] Returns the requested flavor asset.
+      #
+      # @raise [Kaltura::APIError] Raises the default Kaltura errors.
+      ##
+  		def get(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('flavorAsset','get',kparams,false)
+  		end
+
+      ##
+      # Retrieves an enumerable collection of flavor assets given a media entry id.
+      #
+      # @param [String] entry_id The media entry ID to seek flavors for.
+      #
+      # @return [Array] Returns an array of the flavor assets for a given media entry.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
+  		def get_by_entry_id(entry_id)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			perform_request('flavorAsset','getByEntryId',kparams,false)
+  		end
+  		
+      ##
+      # Retrieves an enumerable collection of flavor assets that are playable within the KDP for a given media entry ID.
+      #
+      # @param [String] entry_id The media entry ID to seek flavors for.
+      #
+      # @return [Array] Returns an array of the flavor assets for a given media entry.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.      
+      ##
+  		def get_web_playable_by_entry_id(entry_id)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			perform_request('flavorAsset','getWebPlayableByEntryId',kparams,false)
+  		end
+
+      ##
+      # Add and convert a new flavor asset for a specified entry given a flavor param.
+      #
+      # @param [String] entry_id The media entry ID to add a new flavor asset to.
+      # @param [Integer] flavor_params_id The flavor params ID for conversion type.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
+  		def convert(entry_id, flavor_params_id)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			client.add_param(kparams, 'flavorParamsId', flavor_params_id)
+  			perform_request('flavorAsset','convert',kparams,false)
+  		end
+
+      ##
+      # Reconvert a specific flavor asset.
+      #
+      # @param [String] id The flavor asset id.
+      # 
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
+  		def reconvert(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('flavorAsset','reconvert',kparams,false)
+  		end
+
+      ##
+      # Removes a flavor asset.
+      #
+      # @param [String] id Flavor asset to remove.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
+  		def delete(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('flavorAsset','delete',kparams,false)
+  		end
+
+      ##
+      # Gets a downloadable URL for a flavor asset.
+      #
+      # @param [String] id The flavor asset id.
+      #
+      # @return [String] a URL that can be used to download the requested flavor.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
+  		def get_download_url(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('flavorAsset','getDownloadUrl',kparams,false)
+  		end
+  		
+      ##
+      # Retrieves an enumerable collection of Flavor Assets + Flavor Params given a media entry.
+      #
+      # @param [String] entry_id The media entry to retrieve flavors from.
+      #
+      # @return [Array] Returns a collection of Flavor Assets + Flavor Params.
+      # 
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
+  		def get_flavor_assets_with_params(entry_id)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			perform_request('flavorAsset','getFlavorAssetsWithParams',kparams,false)
+  		end
+  	end #class FlavorAssetService
+	end
+end

data/lib/kaltura/service/flavor_params_service.rb

@@ -0,0 +1,111 @@
+module Kaltura
+  module Service
+    
+    ##
+    # The Flavor Params service is responsible for adding and managing flavor params
+    ##
+    class FlavorParamsService < BaseService
+
+      ##
+      # Adds a new Flavor param.
+      #
+      # @param [Kaltura::FlavorParams] flavor_params The flavor params object to add to Kaltura.
+      #
+      # @return [Kaltura::FlavorParams] Returns the flavor params object as stored in the Kaltura system.
+      #   Would be helpful to store the ID for later use.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors
+      ##
+  		def add(flavor_params)
+  			kparams = {}
+  			client.add_param(kparams, 'flavorParams', flavor_params)
+  			perform_request('flavorParams','add',kparams,false)
+  		end
+
+      ##
+      # Retrieves a flavor param.
+      #
+      # @param [Integer] id The flavor param ID.
+      #
+      # @return [Kaltura::FlavorParams] The requested flavor params.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
+  		def get(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('flavorParams','get',kparams,false)
+  		end
+
+      ##
+      # Updates an existing flavor params object.
+      # As with other Kaltura API update actions, it is best to instantiate a new flavor params
+      # object instead of retrieving the existing one.  You only add fields for the fields you wish to
+      # change.
+      #
+      # @param [Integer] id The flavor param ID.
+      # @param [Kaltura::FlavorParams] A newly instantiated flavor params object that contains the fields 
+      #   you wish to change on the existing flavor params object.
+      #
+      # @return [Kaltura::FlavorParams] The newly updated flavor param object.  The version will have been bumped.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      #
+      ##
+  		def update(id, flavor_params)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			client.add_param(kparams, 'flavorParams', flavor_params)
+  			perform_request('flavorParams','update',kparams,false)
+  		end
+
+      ##
+      # Deletes the requested flavor param.
+      # 
+      # @param [Integer] id The flavor param id.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
+  		def delete(id)
+  			kparams = {}
+  			client.add_param(kparams, 'id', id)
+  			perform_request('flavorParams','delete',kparams,false)
+  		end
+
+      ##
+      # Lists flavor params by filter with paging support.
+      # In addition, all system default parameters will be listed as well.
+      #
+      # @param [Kaltura::Filter::FlavorParamsFilter] filter The filter to apply.
+      # @param [Kaltura::FilterPager] The default Kaltura pager.
+      #
+      # @return [Kaltura::Response::FlavorParamsListResponse] Wrapper for Kaltura::Response::BaseResponse.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
+  		def list(filter=nil, pager=nil)
+  			kparams = {}
+  			client.add_param(kparams, 'filter', filter)
+  			client.add_param(kparams, 'pager', pager)
+  			perform_request('flavorParams','list',kparams,false)
+  		end
+
+      ##
+      # Retrieves all flavor params from a specific Conversion Profile.
+      #
+      # @param [Integer] conversion_profile_id The conversion profile ID.
+      #
+      # @return [Array] Returns an array of Flavor Params with a specific conversion profile.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors      
+      ##
+  		def get_by_conversion_profile_id(conversion_profile_id)
+  			kparams = {}
+  			client.add_param(kparams, 'conversionProfileId', conversion_profile_id)
+  			perform_request('flavorParams','getByConversionProfileId',kparams,false)
+  		end
+  	end #class FlavorParamsService
+	end
+end

data/lib/kaltura/service/live_stream_service.rb

@@ -0,0 +1,140 @@
+module Kaltura
+  module Service
+    
+    ##
+    # The live stream service lets you manage live stream channels.
+    ##
+    class LiveStreamService < BaseService
+      
+      ##
+      # Adds a new live stream entry.
+      # The entry will be queued for provision.  Note, this uses a LiveStreamAdminEntry instead of a 
+      # normal LiveStreamEntry object.  LiveStreamAdminEntry is a child class, and adds a few fields
+      # pertinent to administering a Live stream.
+      #
+      # @param [Kaltura::LiveStreamAdminEntry] live_stream_entry The live stream entry metadata.
+      #   In order to succesfully create a live stream entry you need to have the media_type,
+      #   encoding_ip1, and encoding_ip2 fields populated.
+      #
+      # @return [Kaltura::LiveStreamAdminEntry] Returns the live stream entry saved on the database.
+      #   It might be a good idea to save the ID field on return.
+      #
+      # @raise [Kaltura::APIError] Raises 'PROPERTY_VALIDATION_CANNOT_BE_NULL' if media_type, encoding_ip1, 
+      #   or encoding_ip2 are null.
+      #
+      ##
+  		def add(live_stream_entry)
+  			kparams = {}
+  			client.add_param(kparams, 'liveStreamEntry', live_stream_entry)
+  			perform_request('liveStream','add',kparams,false)
+  		end
+
+      ##
+      # Retrieves a live stream entry by ID.
+      # The Kaltura API docs indicate that this action will return a LiveStreamEntry object, 
+      # but the reality is that it will return a LiveStreamAdminEntry object instead.
+      #
+      # @param [String] entry_id The live stream entry ID.
+      # @param [Integer] version The version of the entry.
+      #
+      # @return [Kaltura::LiveStreamAdminEntry] The requested live stream object.
+      #
+      # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
+      ##
+  		def get(entry_id, version=-1)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			client.add_param(kparams, 'version', version)
+  			perform_request('liveStream','get',kparams,false)
+  		end
+      
+      ##
+      # Updates a live stream entry object.  
+      # Like all of the other Kaltura API update actions it is best to instantiate a new LiveStreamAdminEntry object
+      # instead of pulling the existing one and updating its fields.
+      #
+      # @param [String] entry_id The live stream entry ID.
+      # @param [Kaltura::LiveStreamEntry] live_stream_entry A LiveStreamEntry object with the fields you wish to update populated.
+      #
+      # @return [Kaltura::LiveStreamEntry] Returns the entry_id with the updated fields.  It will also bump the version.
+      #
+      # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
+      #
+      ##
+  		def update(entry_id, live_stream_entry)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			client.add_param(kparams, 'liveStreamEntry', live_stream_entry)
+  			perform_request('liveStream','update',kparams,false)
+  		end
+
+      ##
+      # Deletes a live stream entry object.
+      #
+      # @param [String] entry_id The live stream entry ID.
+      #
+      # @return [nil] Returns nothing
+      #
+      # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
+      ##
+  		def delete(entry_id)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			perform_request('liveStream','delete',kparams,false)
+  		end
+  		
+      ##
+      # Lists live streams by the filter with paging support for large sets of live streams.
+      #
+      # @param [Kaltura::Filter::LiveStreamEntryFilter] The live stream filter is a wrapper for Kaltura::Filter::MediaEntryFilter
+      # @param [Kaltura::FilterPager] The default Kaltura pager.
+      #
+      # @return [Kaltura::Response::LiveStreamListResponse] This is a wrapper for Kaltura::Response::BaseRespsone.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
+  		def list(filter=nil, pager=nil)
+  			kparams = {}
+  			client.add_param(kparams, 'filter', filter)
+  			client.add_param(kparams, 'pager', pager)
+  			perform_request('liveStream','list',kparams,false)
+  		end
+  		
+  		##
+  		# Updates the live stream entries offline thumbnail using a raw jpgeg file.
+  		#
+  		# @param [String] entry_id The live stream entry ID.
+  		# @param [File] file_data The JPEG file to use as the stream is offline backdrop.
+  		#
+  		# @return [Kaltura::LiveStreamEntry] The live stream entry with the updated thumbnail and version.
+  		#
+  		# @raise [Kaltura::APIError] Raises default Kaltura errors plus 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist and
+  	  #   'PERMISSION_DENIED_TO_UPDATE_ENTRY' if the user is does not own the live stream and isn't an administrator.
+  		##
+  		def update_offline_thumbnail_jpeg(entry_id, file_data)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			client.add_param(kparams, 'fileData', file_data)
+  			perform_request('liveStream','updateOfflineThumbnailJpeg',kparams,false)
+  		end
+
+  		##
+  		# Updates the live stream entries offline thumbnail using a URL.
+  		#
+  		# @param [String] entry_id The live stream entry ID.
+  		# @param [File] url The URL to a JPEG file to use as the stream is offline backdrop.
+  		#
+  		# @return [Kaltura::LiveStreamEntry] The live stream entry with the updated thumbnail and version.
+  		#
+  		# @raise [Kaltura::APIError] Raises default Kaltura errors plus 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist and
+  	  #   'PERMISSION_DENIED_TO_UPDATE_ENTRY' if the user is does not own the live stream and isn't an administrator.
+  		##
+  		def update_offline_thumbnail_from_url(entry_id, url)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			client.add_param(kparams, 'url', url)
+  			perform_request('liveStream','updateOfflineThumbnailFromUrl',kparams,false)
+  		end
+  	end #class LiveStreamService
+	end
+end