kaltura-client 18.4.0 → 18.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a15b62e4b056b53c3359a7a53c63a831dc72b9e7d8eeb98842b2e75330cc6fac
-  data.tar.gz: b5d3828090e82c7c922de09df34c6ae8f5ae7e06d0e5d80346e57b75f0025424
+  metadata.gz: 8e59559a271c99fe53b2a928f51c108d932a8ddcf859989276400dacfe8b6047
+  data.tar.gz: 2633c591978f079e95bca5df04dc08857f59d657d717d4dfdcf49f46fea29ca7
 SHA512:
-  metadata.gz: 6aabb46344a08d40e08d8b1dccdb32f21c00834bb9ff64e0e7602177b0f3fd92c0af713738b490e9fc491bbd99f750f9a7d7d0a281dba3f737857bf00caf062c
-  data.tar.gz: 61a2be8071e3e9aafaa7892d0206ed281e03cb5e260d6e970cf8d72c78f08156f180676a03ee86e7ab8435153e3751239113b4f1d9c59cd9abd9477a56ce8d95
+  metadata.gz: b0e74036ec6a7c59a63a1a9db316b1306ebcbb1395b643b54eeaf9f2b1670a8fd7dbd580bbaeebd810fb65952c8b82048723732cc43c82455f69ff1267246943
+  data.tar.gz: 1557c81fb71acd3a9621f3b50c3796728fbc6d80267b7d63be0de3a50568075d1108cad14f4ecde6cec8bd197c6b3b025c36f4b4d04f09f097fa953fc8040983

data/README

@@ -1,5 +1,5 @@
 Kaltura Ruby API Client Library.
-Compatible with Kaltura server version 18.4.0 and above.
+Compatible with Kaltura server version 18.10.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-05-09'
-			self.api_version = '18.4.0'
+			self.client_tag = 'ruby:22-07-27'
+			self.api_version = '18.10.0'
 		end
 		
 		def client_tag=(value)

data/lib/kaltura_enums.rb

@@ -814,6 +814,12 @@ module Kaltura
 		TIMEHASH = 2
 	end
 
+	class KalturaZoomGroupParticipationType
+		NO_CLASSIFICATION = 0
+		OPT_IN = 1
+		OPT_OUT = 2
+	end
+
 	class KalturaAccessControlOrderBy
 		CREATED_AT_ASC = "+createdAt"
 		CREATED_AT_DESC = "-createdAt"
@@ -3567,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_elastic_search_client_plugin.rb

@@ -204,6 +204,7 @@ module Kaltura
 
 	class KalturaESearchUserFieldName
 		COMPANY = "company"
+		COUNTRY = "country"
 		CREATED_AT = "created_at"
 		EMAIL = "email"
 		FIRST_NAME = "first_name"

data/lib/kaltura_plugins/kaltura_group_client_plugin.rb

@@ -37,6 +37,7 @@ module Kaltura
 
 	class KalturaESearchGroupFieldName
 		COMPANY = "company"
+		COUNTRY = "country"
 		CREATED_AT = "created_at"
 		EMAIL = "email"
 		FIRST_NAME = "first_name"

data/lib/kaltura_plugins/kaltura_reach_client_plugin.rb

@@ -325,6 +325,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 +469,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

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

data/lib/kaltura_plugins/kaltura_vendor_client_plugin.rb

@@ -133,6 +133,9 @@ module Kaltura
 		attr_accessor :enable_zoom_transcription
 		attr_accessor :zoom_account_description
 		attr_accessor :enable_meeting_upload
+		attr_accessor :opt_out_group_names
+		attr_accessor :opt_in_group_names
+		attr_accessor :group_participation_type
 
 		def enable_recording_upload=(val)
 			@enable_recording_upload = val.to_i
@@ -149,6 +152,9 @@ module Kaltura
 		def enable_meeting_upload=(val)
 			@enable_meeting_upload = val.to_i
 		end
+		def group_participation_type=(val)
+			@group_participation_type = val.to_i
+		end
 
 		def from_xml(xml_element)
 			super
@@ -182,6 +188,15 @@ module Kaltura
 			if xml_element.elements['enableMeetingUpload'] != nil
 				self.enable_meeting_upload = xml_element.elements['enableMeetingUpload'].text
 			end
+			if xml_element.elements['optOutGroupNames'] != nil
+				self.opt_out_group_names = xml_element.elements['optOutGroupNames'].text
+			end
+			if xml_element.elements['optInGroupNames'] != nil
+				self.opt_in_group_names = xml_element.elements['optInGroupNames'].text
+			end
+			if xml_element.elements['groupParticipationType'] != nil
+				self.group_participation_type = xml_element.elements['groupParticipationType'].text
+			end
 		end
 
 	end

data/lib/kaltura_types.rb

@@ -4549,13 +4549,26 @@ module Kaltura
 		# 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 :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
@@ -8668,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)
@@ -8810,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
@@ -10193,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
@@ -10255,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
@@ -13997,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
@@ -17809,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
@@ -17825,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
@@ -18799,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
@@ -18850,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.4.0
+  version: 18.10.0
 platform: ruby
 authors:
 - Kaltura Inc.