kaltura-client 18.7.0 → 18.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a482098a8479c9b6e3d8808243a8d158abcfda9f85f213f58696ee6b5c072be
-  data.tar.gz: 8c99eb797974981b8a575b6f3d5fb61f631fe87bfb9c89b6356f99044226a18e
+  metadata.gz: eb1b389640477eeea83c6eef22f451fe14cdabb3999b81857d768c4e400fc448
+  data.tar.gz: 9d8ceb698bbb51167ec0acebeea2cdd9e9521f1b080c7c2acdd3bab295f74221
 SHA512:
-  metadata.gz: 688d545ff5ca075ee62774416757cbc76b870d79d2b5cadeb262aba7eccc05f720ccef1ca93637d8fa6e75a8eec574bbed6ade01f129e14211130fe773e395cf
-  data.tar.gz: f7003acf5fd2524d9b8a9c72e977766a8a3c26f039706c524ecd82c8f15bb4926cf3c02c640630825a7fd636f76298df99abb1077f5ff5855f9aa9f2c89274a7
+  metadata.gz: 4333d5d022d393c1f30d134b492e8531cbb48c767528ef746a85f13124c9c8b258060a72485cd6e0cddc3e91264d9ad10e13575c4117271cf88333b33b660a06
+  data.tar.gz: b15bd05a7c5a5cec9665647d0c96d1c6ef280b6a3c3f0a52d810b4407b9f15ebfc8fc4dfa7d782057ecba92675decd48ebc15fcd516a27cbd82f258bbb27b86f

data/README

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

data/lib/kaltura_client.rb

@@ -460,12 +460,13 @@ module Kaltura
 
 		# add batch job that sends an email with a link to download an updated CSV that contains list of entries
 		# @return [string]
-		def export_to_csv(filter=KalturaNotImplemented, metadata_profile_id=KalturaNotImplemented, additional_fields=KalturaNotImplemented, mapped_fields=KalturaNotImplemented)
+		def export_to_csv(filter=KalturaNotImplemented, metadata_profile_id=KalturaNotImplemented, additional_fields=KalturaNotImplemented, mapped_fields=KalturaNotImplemented, options=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'filter', filter)
 			client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
 			client.add_param(kparams, 'additionalFields', additional_fields)
 			client.add_param(kparams, 'mappedFields', mapped_fields)
+			client.add_param(kparams, 'options', options)
 			client.queue_service_action_call('baseentry', 'exportToCsv', 'string', kparams)
 			if (client.is_multirequest)
 				return nil
@@ -968,6 +969,22 @@ module Kaltura
 			return client.do_queue()
 		end
 
+		# Creates a batch job that sends an email with a link to download a CSV containing a list of categories
+		# @return [string]
+		def export_to_csv(filter=KalturaNotImplemented, metadata_profile_id=KalturaNotImplemented, additional_fields=KalturaNotImplemented, mapped_fields=KalturaNotImplemented, options=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
+			client.add_param(kparams, 'additionalFields', additional_fields)
+			client.add_param(kparams, 'mappedFields', mapped_fields)
+			client.add_param(kparams, 'options', options)
+			client.queue_service_action_call('category', 'exportToCsv', 'string', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
 		# Get Category by id
 		# @return [KalturaCategory]
 		def get(id)
@@ -5619,12 +5636,13 @@ module Kaltura
 
 		# Creates a batch job that sends an email with a link to download a CSV containing a list of users
 		# @return [string]
-		def export_to_csv(filter=KalturaNotImplemented, metadata_profile_id=KalturaNotImplemented, additional_fields=KalturaNotImplemented, mapped_fields=KalturaNotImplemented)
+		def export_to_csv(filter=KalturaNotImplemented, metadata_profile_id=KalturaNotImplemented, additional_fields=KalturaNotImplemented, mapped_fields=KalturaNotImplemented, options=KalturaNotImplemented)
 			kparams = {}
 			client.add_param(kparams, 'filter', filter)
 			client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
 			client.add_param(kparams, 'additionalFields', additional_fields)
 			client.add_param(kparams, 'mappedFields', mapped_fields)
+			client.add_param(kparams, 'options', options)
 			client.queue_service_action_call('user', 'exportToCsv', 'string', kparams)
 			if (client.is_multirequest)
 				return nil
@@ -6364,8 +6382,8 @@ module Kaltura
 		
 		def initialize(client)
 			super(client)
-			self.client_tag = 'ruby:22-06-13'
-			self.api_version = '18.7.0'
+			self.client_tag = 'ruby:22-08-08'
+			self.api_version = '18.11.0'
 		end
 		
 		def client_tag=(value)

data/lib/kaltura_enums.rb

@@ -3573,6 +3573,7 @@ module Kaltura
 		TOP_CUSTOM_VAR3 = "59"
 		SELF_SERVE_USAGE = "60"
 		FLAVOR_PARAMS_TRANSCODING_USAGE = "61"
+		PLAYER_HIGHLIGHTS = "62"
 		PARTNER_USAGE = "201"
 		MAP_OVERLAY_COUNTRY_REALTIME = "10001"
 		MAP_OVERLAY_REGION_REALTIME = "10002"

data/lib/kaltura_plugins/kaltura_caption_client_plugin.rb

@@ -515,6 +515,15 @@ module Kaltura
 			return client.get_serve_url()
 		end
 
+		# Serves caption file as Json by its ID
+		# @return [file]
+		def serve_as_json(caption_asset_id)
+			kparams = {}
+			client.add_param(kparams, 'captionAssetId', caption_asset_id)
+			client.queue_service_action_call('caption_captionasset', 'serveAsJson', 'file', kparams)
+			return client.get_serve_url()
+		end
+
 		# Serves caption by entry id and thumnail params id
 		# @return [file]
 		def serve_by_entry_id(entry_id, caption_param_id=KalturaNotImplemented)

data/lib/kaltura_plugins/kaltura_reach_client_plugin.rb

@@ -46,6 +46,7 @@ module Kaltura
 		ERROR = 6
 		ABORTED = 7
 		PENDING_ENTRY_READY = 8
+		SCHEDULED = 9
 	end
 
 	class KalturaReachProfileContentDeletionPolicy
@@ -86,6 +87,7 @@ module Kaltura
 		CHAPTERING = 5
 		INTELLIGENT_TAGGING = 6
 		DUBBING = 7
+		LIVE_CAPTION = 8
 	end
 
 	class KalturaVendorServiceTurnAroundTime
@@ -325,6 +327,8 @@ module Kaltura
 		attr_accessor :service_type
 		attr_accessor :service_feature
 		attr_accessor :turn_around_time
+		# The vendor's task internal Id
+		attr_accessor :external_task_id
 
 		def id=(val)
 			@id = val.to_i
@@ -467,6 +471,9 @@ module Kaltura
 			if xml_element.elements['turnAroundTime'] != nil
 				self.turn_around_time = xml_element.elements['turnAroundTime'].text
 			end
+			if xml_element.elements['externalTaskId'] != nil
+				self.external_task_id = xml_element.elements['externalTaskId'].text
+			end
 		end
 
 	end
@@ -896,6 +903,36 @@ module Kaltura
 
 	end
 
+	class KalturaScheduledVendorTaskData < KalturaVendorTaskData
+		attr_accessor :start_date
+		attr_accessor :end_date
+		attr_accessor :scheduled_event_id
+
+		def start_date=(val)
+			@start_date = val.to_i
+		end
+		def end_date=(val)
+			@end_date = val.to_i
+		end
+		def scheduled_event_id=(val)
+			@scheduled_event_id = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['startDate'] != nil
+				self.start_date = xml_element.elements['startDate'].text
+			end
+			if xml_element.elements['endDate'] != nil
+				self.end_date = xml_element.elements['endDate'].text
+			end
+			if xml_element.elements['scheduledEventId'] != nil
+				self.scheduled_event_id = xml_element.elements['scheduledEventId'].text
+			end
+		end
+
+	end
+
 	class KalturaUnlimitedVendorCredit < KalturaBaseVendorCredit
 		attr_accessor :credit
 		attr_accessor :from_date
@@ -1525,6 +1562,36 @@ module Kaltura
 
 	end
 
+	class KalturaVendorLiveCaptionCatalogItem < KalturaVendorCaptionsCatalogItem
+		attr_accessor :minimal_refund_time
+		attr_accessor :minimal_order_time
+		attr_accessor :duration_limit
+
+		def minimal_refund_time=(val)
+			@minimal_refund_time = val.to_i
+		end
+		def minimal_order_time=(val)
+			@minimal_order_time = val.to_i
+		end
+		def duration_limit=(val)
+			@duration_limit = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['minimalRefundTime'] != nil
+				self.minimal_refund_time = xml_element.elements['minimalRefundTime'].text
+			end
+			if xml_element.elements['minimalOrderTime'] != nil
+				self.minimal_order_time = xml_element.elements['minimalOrderTime'].text
+			end
+			if xml_element.elements['durationLimit'] != nil
+				self.duration_limit = xml_element.elements['durationLimit'].text
+			end
+		end
+
+	end
+
 	class KalturaVendorTranslationCatalogItem < KalturaVendorCaptionsCatalogItem
 		attr_accessor :target_language
 
@@ -1666,6 +1733,15 @@ module Kaltura
 
 	end
 
+	class KalturaVendorLiveCaptionCatalogItemFilter < KalturaVendorCaptionsCatalogItemBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
 	class KalturaVendorTranslationCatalogItemBaseFilter < KalturaVendorCaptionsCatalogItemFilter
 		attr_accessor :target_language_equal
 		attr_accessor :target_language_in

data/lib/kaltura_plugins/kaltura_schedule_client_plugin.rb

@@ -208,6 +208,33 @@ module Kaltura
 
 	end
 
+	class KalturaLiveFeature < KalturaObjectBase
+		attr_accessor :system_name
+		attr_accessor :pre_start_time
+		attr_accessor :post_end_time
+
+		def pre_start_time=(val)
+			@pre_start_time = val.to_i
+		end
+		def post_end_time=(val)
+			@post_end_time = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['systemName'] != nil
+				self.system_name = xml_element.elements['systemName'].text
+			end
+			if xml_element.elements['preStartTime'] != nil
+				self.pre_start_time = xml_element.elements['preStartTime'].text
+			end
+			if xml_element.elements['postEndTime'] != nil
+				self.post_end_time = xml_element.elements['postEndTime'].text
+			end
+		end
+
+	end
+
 	class KalturaScheduleEventRecurrence < KalturaObjectBase
 		attr_accessor :name
 		attr_accessor :frequency
@@ -663,6 +690,31 @@ module Kaltura
 
 	end
 
+	class KalturaLiveCaptionFeature < KalturaLiveFeature
+		attr_accessor :media_url
+		attr_accessor :media_key
+		attr_accessor :caption_url
+		attr_accessor :caption_token
+
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['mediaUrl'] != nil
+				self.media_url = xml_element.elements['mediaUrl'].text
+			end
+			if xml_element.elements['mediaKey'] != nil
+				self.media_key = xml_element.elements['mediaKey'].text
+			end
+			if xml_element.elements['captionUrl'] != nil
+				self.caption_url = xml_element.elements['captionUrl'].text
+			end
+			if xml_element.elements['captionToken'] != nil
+				self.caption_token = xml_element.elements['captionToken'].text
+			end
+		end
+
+	end
+
 	class KalturaLiveEntryScheduleResource < KalturaScheduleResource
 		attr_accessor :entry_id
 
@@ -1124,6 +1176,8 @@ module Kaltura
 		attr_accessor :post_end_entry_id
 		# Detect whether "real" live can interrupt to the "main" content
 		attr_accessor :is_content_interruptible
+		# list of live features that apply to the event
+		attr_accessor :live_features
 
 		def projected_audience=(val)
 			@projected_audience = val.to_i
@@ -1161,6 +1215,9 @@ module Kaltura
 			if xml_element.elements['isContentInterruptible'] != nil
 				self.is_content_interruptible = xml_element.elements['isContentInterruptible'].text
 			end
+			if xml_element.elements['liveFeatures'] != nil
+				self.live_features = KalturaClientBase.object_from_xml(xml_element.elements['liveFeatures'], 'KalturaLiveFeature')
+			end
 		end
 
 	end
@@ -1563,6 +1620,20 @@ module Kaltura
 			end
 			return client.do_queue()
 		end
+
+		# Add feature to live event
+		# @return [KalturaLiveStreamScheduleEvent]
+		def update_live_feature(scheduled_event_id, feature_name, live_feature)
+			kparams = {}
+			client.add_param(kparams, 'scheduledEventId', scheduled_event_id)
+			client.add_param(kparams, 'featureName', feature_name)
+			client.add_param(kparams, 'liveFeature', live_feature)
+			client.queue_service_action_call('schedule_scheduleevent', 'updateLiveFeature', 'KalturaLiveStreamScheduleEvent', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
 	end
 
 	# The ScheduleResource service enables you to create and manage (update, delete, retrieve, etc.) the resources required for scheduled events (cameras, capture devices, etc.).

data/lib/kaltura_types.rb

@@ -4546,17 +4546,29 @@ module Kaltura
 	end
 
 	class KalturaExportToCsvOptions < KalturaObjectBase
+		# The format of the outputted date string. There are also several predefined date constants that may be used instead, so for example DATE_RSS contains the format string 'D, d M Y H:i:s'.
+		# 	 https://www.php.net/manual/en/function.date.php
+		attr_accessor :format
 		# Setting this property will cause additional columns to be added to the final report. The columns will be related to the specific object type passed (currently only MEDIA_CLIP is supported).
 		# 	 Please note that this property will NOT change the result filter in any way (i.e passing MEDIA_CLIP here will not force the report to return only media items).
-		# 	 /
-		attr_accessor :format
+		attr_accessor :type_equal
+		attr_accessor :default_header
 
+		def default_header=(val)
+			@default_header = val.to_i
+		end
 
 		def from_xml(xml_element)
 			super
 			if xml_element.elements['format'] != nil
 				self.format = xml_element.elements['format'].text
 			end
+			if xml_element.elements['typeEqual'] != nil
+				self.type_equal = xml_element.elements['typeEqual'].text
+			end
+			if xml_element.elements['defaultHeader'] != nil
+				self.default_header = xml_element.elements['defaultHeader'].text
+			end
 		end
 
 	end
@@ -8669,6 +8681,8 @@ module Kaltura
 		attr_accessor :virtual_event_id_in
 		# filter by origin
 		attr_accessor :origin_in
+		# filter by ui conf id
+		attr_accessor :ui_conf_id_in
 
 		def search_in_tags=(val)
 			@search_in_tags = to_b(val)
@@ -8811,6 +8825,9 @@ module Kaltura
 			if xml_element.elements['originIn'] != nil
 				self.origin_in = xml_element.elements['originIn'].text
 			end
+			if xml_element.elements['uiConfIdIn'] != nil
+				self.ui_conf_id_in = xml_element.elements['uiConfIdIn'].text
+			end
 		end
 
 	end
@@ -10194,10 +10211,14 @@ module Kaltura
 		attr_accessor :created_at
 		# Last update date as Unix timestamp (In seconds)
 		attr_accessor :updated_at
-		# Upload url - to explicitly determine to which domain to adress the uploadToken->upload call
+		# Upload url - to explicitly determine to which domain to address the uploadToken->upload call
 		attr_accessor :upload_url
-		# autoFinalize - Should the upload be finalized once the file size on disk matches the file size reproted when adding the upload token.
+		# autoFinalize - Should the upload be finalized once the file size on disk matches the file size reported when adding the upload token.
 		attr_accessor :auto_finalize
+		# The type of the object this token is attached to.
+		attr_accessor :attached_object_type
+		# The id of the object this token is attached to.
+		attr_accessor :attached_object_id
 
 		def partner_id=(val)
 			@partner_id = val.to_i
@@ -10256,6 +10277,12 @@ module Kaltura
 			if xml_element.elements['autoFinalize'] != nil
 				self.auto_finalize = xml_element.elements['autoFinalize'].text
 			end
+			if xml_element.elements['attachedObjectType'] != nil
+				self.attached_object_type = xml_element.elements['attachedObjectType'].text
+			end
+			if xml_element.elements['attachedObjectId'] != nil
+				self.attached_object_id = xml_element.elements['attachedObjectId'].text
+			end
 		end
 
 	end
@@ -13998,6 +14025,22 @@ module Kaltura
 
 	end
 
+	class KalturaKeyValueExtended < KalturaKeyValue
+		attr_accessor :predefined_format
+
+		def predefined_format=(val)
+			@predefined_format = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['predefinedFormat'] != nil
+				self.predefined_format = xml_element.elements['predefinedFormat'].text
+			end
+		end
+
+	end
+
 	class KalturaLimitFlavorsRestriction < KalturaBaseRestriction
 		# Limit flavors restriction type (Allow or deny)
 		attr_accessor :limit_flavors_restriction_type
@@ -17810,6 +17853,7 @@ module Kaltura
 		attr_accessor :additional_fields
 		# Array of header names and their mapped user fields
 		attr_accessor :mapped_fields
+		attr_accessor :options
 
 		def metadata_profile_id=(val)
 			@metadata_profile_id = val.to_i
@@ -17826,6 +17870,9 @@ module Kaltura
 			if xml_element.elements['mappedFields'] != nil
 				self.mapped_fields = KalturaClientBase.object_from_xml(xml_element.elements['mappedFields'], 'KalturaKeyValue')
 			end
+			if xml_element.elements['options'] != nil
+				self.options = KalturaClientBase.object_from_xml(xml_element.elements['options'], 'KalturaExportToCsvOptions')
+			end
 		end
 
 	end
@@ -18800,15 +18847,6 @@ module Kaltura
 
 	end
 
-	class KalturaCategoryEntryFilter < KalturaCategoryEntryBaseFilter
-
-
-		def from_xml(xml_element)
-			super
-		end
-
-	end
-
 	class KalturaCategoryFilter < KalturaCategoryBaseFilter
 		attr_accessor :free_text
 		attr_accessor :members_in
@@ -18851,6 +18889,29 @@ module Kaltura
 
 	end
 
+	class KalturaCategoriesCsvJobData < KalturaMappedObjectsCsvJobData
+		# The filter should return the list of categories that need to be specified in the csv.
+		attr_accessor :filter
+
+
+		def from_xml(xml_element)
+			super
+			if xml_element.elements['filter'] != nil
+				self.filter = KalturaClientBase.object_from_xml(xml_element.elements['filter'], 'KalturaCategoryFilter')
+			end
+		end
+
+	end
+
+	class KalturaCategoryEntryFilter < KalturaCategoryEntryBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
 	class KalturaConstantXsltSyndicationFeed < KalturaGenericXsltSyndicationFeed
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kaltura-client
 version: !ruby/object:Gem::Version
-  version: 18.7.0
+  version: 18.11.0
 platform: ruby
 authors:
 - Kaltura Inc.