kaltura-client 3.3.0 → 14.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +7 -0
  2. data/README +23 -23
  3. data/lib/kaltura_client.rb +2054 -1860
  4. data/lib/kaltura_client_base.rb +4 -1
  5. data/lib/kaltura_enums.rb +612 -36
  6. data/lib/kaltura_plugins/kaltura_activiti_business_process_notification_client_plugin.rb +96 -0
  7. data/lib/kaltura_plugins/kaltura_ad_cue_point_client_plugin.rb +46 -17
  8. data/lib/kaltura_plugins/kaltura_admin_console_client_plugin.rb +61 -251
  9. data/lib/kaltura_plugins/kaltura_annotation_client_plugin.rb +131 -60
  10. data/lib/kaltura_plugins/kaltura_aspera_client_plugin.rb +62 -0
  11. data/lib/kaltura_plugins/kaltura_attachment_client_plugin.rb +83 -55
  12. data/lib/kaltura_plugins/kaltura_audit_client_plugin.rb +613 -0
  13. data/lib/kaltura_plugins/kaltura_avn_distribution_client_plugin.rb +109 -0
  14. data/lib/kaltura_plugins/kaltura_bpm_event_notification_integration_client_plugin.rb +61 -0
  15. data/lib/kaltura_plugins/kaltura_bulk_upload_client_plugin.rb +17 -19
  16. data/lib/kaltura_plugins/kaltura_bulk_upload_csv_client_plugin.rb +7 -6
  17. data/lib/kaltura_plugins/kaltura_bulk_upload_filter_client_plugin.rb +33 -13
  18. data/lib/kaltura_plugins/kaltura_bulk_upload_xml_client_plugin.rb +1 -2
  19. data/lib/kaltura_plugins/kaltura_business_process_notification_client_plugin.rb +545 -0
  20. data/lib/kaltura_plugins/kaltura_caption_client_plugin.rb +235 -114
  21. data/lib/kaltura_plugins/kaltura_caption_search_client_plugin.rb +86 -29
  22. data/lib/kaltura_plugins/kaltura_cielo24client_plugin.rb +39 -17
  23. data/lib/kaltura_plugins/kaltura_code_cue_point_client_plugin.rb +49 -18
  24. data/lib/kaltura_plugins/kaltura_comcast_mrss_distribution_client_plugin.rb +163 -0
  25. data/lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb +846 -439
  26. data/lib/kaltura_plugins/kaltura_cross_kaltura_distribution_client_plugin.rb +232 -0
  27. data/lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb +229 -74
  28. data/lib/kaltura_plugins/kaltura_dailymotion_distribution_client_plugin.rb +199 -0
  29. data/lib/kaltura_plugins/kaltura_document_client_plugin.rb +140 -97
  30. data/lib/kaltura_plugins/kaltura_double_click_distribution_client_plugin.rb +142 -0
  31. data/lib/kaltura_plugins/kaltura_drm_client_plugin.rb +635 -0
  32. data/lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb +485 -196
  33. data/lib/kaltura_plugins/kaltura_drop_folder_xml_bulk_upload_client_plugin.rb +19 -1
  34. data/lib/kaltura_plugins/kaltura_elastic_search_client_plugin.rb +1228 -0
  35. data/lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb +178 -89
  36. data/lib/kaltura_plugins/kaltura_event_cue_point_client_plugin.rb +10 -4
  37. data/lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb +205 -95
  38. data/lib/kaltura_plugins/kaltura_external_media_client_plugin.rb +43 -32
  39. data/lib/kaltura_plugins/kaltura_facebook_distribution_client_plugin.rb +183 -0
  40. data/lib/kaltura_plugins/kaltura_fairplay_client_plugin.rb +62 -0
  41. data/lib/kaltura_plugins/kaltura_feed_drop_folder_client_plugin.rb +40 -16
  42. data/lib/kaltura_plugins/kaltura_file_sync_client_plugin.rb +182 -67
  43. data/lib/kaltura_plugins/kaltura_freewheel_distribution_client_plugin.rb +157 -0
  44. data/lib/kaltura_plugins/kaltura_freewheel_generic_distribution_client_plugin.rb +172 -0
  45. data/lib/kaltura_plugins/kaltura_ftp_distribution_client_plugin.rb +258 -0
  46. data/lib/kaltura_plugins/kaltura_http_notification_client_plugin.rb +154 -102
  47. data/lib/kaltura_plugins/kaltura_hulu_distribution_client_plugin.rb +213 -0
  48. data/lib/kaltura_plugins/kaltura_idetic_distribution_client_plugin.rb +131 -0
  49. data/lib/kaltura_plugins/kaltura_integration_client_plugin.rb +19 -10
  50. data/lib/kaltura_plugins/kaltura_kaltura_internal_tools_client_plugin.rb +1 -87
  51. data/lib/kaltura_plugins/kaltura_kontiki_client_plugin.rb +19 -10
  52. data/lib/kaltura_plugins/kaltura_like_client_plugin.rb +45 -25
  53. data/lib/kaltura_plugins/kaltura_metadata_client_plugin.rb +435 -213
  54. data/lib/kaltura_plugins/kaltura_metro_pcs_distribution_client_plugin.rb +155 -0
  55. data/lib/kaltura_plugins/kaltura_msn_distribution_client_plugin.rb +186 -0
  56. data/lib/kaltura_plugins/kaltura_play_ready_client_plugin.rb +482 -0
  57. data/lib/kaltura_plugins/kaltura_poll_client_plugin.rb +116 -0
  58. data/lib/kaltura_plugins/kaltura_push_notification_client_plugin.rb +154 -0
  59. data/lib/kaltura_plugins/kaltura_quick_play_distribution_client_plugin.rb +187 -0
  60. data/lib/kaltura_plugins/kaltura_quiz_client_plugin.rb +155 -58
  61. data/lib/kaltura_plugins/kaltura_schedule_bulk_upload_client_plugin.rb +107 -0
  62. data/lib/kaltura_plugins/kaltura_schedule_client_plugin.rb +1580 -0
  63. data/lib/kaltura_plugins/kaltura_schedule_drop_folder_client_plugin.rb +52 -0
  64. data/lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb +277 -71
  65. data/lib/kaltura_plugins/kaltura_scheduled_task_content_distribution_client_plugin.rb +4 -3
  66. data/lib/kaltura_plugins/kaltura_scheduled_task_event_notification_client_plugin.rb +4 -3
  67. data/lib/kaltura_plugins/kaltura_scheduled_task_metadata_client_plugin.rb +10 -7
  68. data/lib/kaltura_plugins/kaltura_short_link_client_plugin.rb +113 -66
  69. data/lib/kaltura_plugins/kaltura_system_partner_client_plugin.rb +81 -517
  70. data/lib/kaltura_plugins/kaltura_tag_search_client_plugin.rb +63 -30
  71. data/lib/kaltura_plugins/kaltura_thumb_cue_point_client_plugin.rb +40 -16
  72. data/lib/kaltura_plugins/kaltura_transcript_client_plugin.rb +44 -8
  73. data/lib/kaltura_plugins/kaltura_unicorn_distribution_client_plugin.rb +212 -0
  74. data/lib/kaltura_plugins/kaltura_var_console_client_plugin.rb +75 -74
  75. data/lib/kaltura_plugins/kaltura_velocix_client_plugin.rb +10 -4
  76. data/lib/kaltura_plugins/kaltura_view_history_client_plugin.rb +112 -0
  77. data/lib/kaltura_plugins/kaltura_virus_scan_client_plugin.rb +119 -59
  78. data/lib/kaltura_plugins/kaltura_voicebase_client_plugin.rb +34 -19
  79. data/lib/kaltura_plugins/kaltura_webex_drop_folder_client_plugin.rb +207 -0
  80. data/lib/kaltura_plugins/kaltura_widevine_client_plugin.rb +299 -0
  81. data/lib/kaltura_plugins/kaltura_wowza_client_plugin.rb +22 -13
  82. data/lib/kaltura_plugins/kaltura_yahoo_distribution_client_plugin.rb +155 -0
  83. data/lib/kaltura_plugins/kaltura_you_tube_distribution_client_plugin.rb +382 -0
  84. data/lib/kaltura_plugins/kaltura_youtube_api_distribution_client_plugin.rb +219 -0
  85. data/lib/kaltura_types.rb +10305 -4858
  86. data/test/access_control_service_test.rb +43 -20
  87. data/test/base_entry_service_test.rb +57 -67
  88. data/test/configuration_test.rb +2 -34
  89. data/test/cue_point_service_test.rb +1 -1
  90. data/test/data_service_test.rb +19 -5
  91. data/test/document_service_test.rb +1 -1
  92. data/test/media_service_test.rb +296 -296
  93. data/test/metadata_profile_service_test.rb +1 -1
  94. metadata +52 -21
@@ -8,7 +8,7 @@
8
8
  # to do with audio, video, and animation what Wiki platfroms allow them to do with
9
9
  # text.
10
10
  #
11
- # Copyright (C) 2006-2015 Kaltura Inc.
11
+ # Copyright (C) 2006-2019 Kaltura Inc.
12
12
  #
13
13
  # This program is free software: you can redistribute it and/or modify
14
14
  # it under the terms of the GNU Affero General Public License as
@@ -42,41 +42,50 @@ module Kaltura
42
42
 
43
43
  def from_xml(xml_element)
44
44
  super
45
- self.service_token = xml_element.elements['serviceToken'].text
45
+ if xml_element.elements['serviceToken'] != nil
46
+ self.service_token = xml_element.elements['serviceToken'].text
47
+ end
46
48
  end
47
49
 
48
50
  end
49
51
 
50
52
  class KalturaKontikiStorageDeleteJobData < KalturaStorageDeleteJobData
51
53
  # Unique Kontiki MOID for the content uploaded to Kontiki
52
- #
53
54
  attr_accessor :content_moid
54
55
  attr_accessor :service_token
55
56
 
56
57
 
57
58
  def from_xml(xml_element)
58
59
  super
59
- self.content_moid = xml_element.elements['contentMoid'].text
60
- self.service_token = xml_element.elements['serviceToken'].text
60
+ if xml_element.elements['contentMoid'] != nil
61
+ self.content_moid = xml_element.elements['contentMoid'].text
62
+ end
63
+ if xml_element.elements['serviceToken'] != nil
64
+ self.service_token = xml_element.elements['serviceToken'].text
65
+ end
61
66
  end
62
67
 
63
68
  end
64
69
 
65
70
  class KalturaKontikiStorageExportJobData < KalturaStorageExportJobData
66
71
  # Holds the id of the exported asset
67
- #
68
72
  attr_accessor :flavor_asset_id
69
73
  # Unique Kontiki MOID for the content uploaded to Kontiki
70
- #
71
74
  attr_accessor :content_moid
72
75
  attr_accessor :service_token
73
76
 
74
77
 
75
78
  def from_xml(xml_element)
76
79
  super
77
- self.flavor_asset_id = xml_element.elements['flavorAssetId'].text
78
- self.content_moid = xml_element.elements['contentMoid'].text
79
- self.service_token = xml_element.elements['serviceToken'].text
80
+ if xml_element.elements['flavorAssetId'] != nil
81
+ self.flavor_asset_id = xml_element.elements['flavorAssetId'].text
82
+ end
83
+ if xml_element.elements['contentMoid'] != nil
84
+ self.content_moid = xml_element.elements['contentMoid'].text
85
+ end
86
+ if xml_element.elements['serviceToken'] != nil
87
+ self.service_token = xml_element.elements['serviceToken'].text
88
+ end
80
89
  end
81
90
 
82
91
  end
@@ -8,7 +8,7 @@
8
8
  # to do with audio, video, and animation what Wiki platfroms allow them to do with
9
9
  # text.
10
10
  #
11
- # Copyright (C) 2006-2015 Kaltura Inc.
11
+ # Copyright (C) 2006-2019 Kaltura Inc.
12
12
  #
13
13
  # This program is free software: you can redistribute it and/or modify
14
14
  # it under the terms of the GNU Affero General Public License as
@@ -34,13 +34,10 @@ module Kaltura
34
34
 
35
35
  class KalturaLike < KalturaObjectBase
36
36
  # The id of the entry that the like belongs to
37
- #
38
37
  attr_accessor :entry_id
39
38
  # The id of user that the like belongs to
40
- #
41
39
  attr_accessor :user_id
42
40
  # The date of the like's creation
43
- #
44
41
  attr_accessor :created_at
45
42
 
46
43
  def created_at=(val)
@@ -49,9 +46,15 @@ module Kaltura
49
46
 
50
47
  def from_xml(xml_element)
51
48
  super
52
- self.entry_id = xml_element.elements['entryId'].text
53
- self.user_id = xml_element.elements['userId'].text
54
- self.created_at = xml_element.elements['createdAt'].text
49
+ if xml_element.elements['entryId'] != nil
50
+ self.entry_id = xml_element.elements['entryId'].text
51
+ end
52
+ if xml_element.elements['userId'] != nil
53
+ self.user_id = xml_element.elements['userId'].text
54
+ end
55
+ if xml_element.elements['createdAt'] != nil
56
+ self.created_at = xml_element.elements['createdAt'].text
57
+ end
55
58
  end
56
59
 
57
60
  end
@@ -62,13 +65,16 @@ module Kaltura
62
65
 
63
66
  def from_xml(xml_element)
64
67
  super
65
- self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaLike')
68
+ if xml_element.elements['objects'] != nil
69
+ self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaLike')
70
+ end
66
71
  end
67
72
 
68
73
  end
69
74
 
70
75
  class KalturaLikeBaseFilter < KalturaRelatedFilter
71
76
  attr_accessor :entry_id_equal
77
+ attr_accessor :entry_id_in
72
78
  attr_accessor :user_id_equal
73
79
  attr_accessor :created_at_greater_than_or_equal
74
80
  attr_accessor :created_at_less_than_or_equal
@@ -82,10 +88,21 @@ module Kaltura
82
88
 
83
89
  def from_xml(xml_element)
84
90
  super
85
- self.entry_id_equal = xml_element.elements['entryIdEqual'].text
86
- self.user_id_equal = xml_element.elements['userIdEqual'].text
87
- self.created_at_greater_than_or_equal = xml_element.elements['createdAtGreaterThanOrEqual'].text
88
- self.created_at_less_than_or_equal = xml_element.elements['createdAtLessThanOrEqual'].text
91
+ if xml_element.elements['entryIdEqual'] != nil
92
+ self.entry_id_equal = xml_element.elements['entryIdEqual'].text
93
+ end
94
+ if xml_element.elements['entryIdIn'] != nil
95
+ self.entry_id_in = xml_element.elements['entryIdIn'].text
96
+ end
97
+ if xml_element.elements['userIdEqual'] != nil
98
+ self.user_id_equal = xml_element.elements['userIdEqual'].text
99
+ end
100
+ if xml_element.elements['createdAtGreaterThanOrEqual'] != nil
101
+ self.created_at_greater_than_or_equal = xml_element.elements['createdAtGreaterThanOrEqual'].text
102
+ end
103
+ if xml_element.elements['createdAtLessThanOrEqual'] != nil
104
+ self.created_at_less_than_or_equal = xml_element.elements['createdAtLessThanOrEqual'].text
105
+ end
89
106
  end
90
107
 
91
108
  end
@@ -101,48 +118,51 @@ module Kaltura
101
118
 
102
119
 
103
120
  # Allows user to 'like' or 'unlike' and entry
104
- #
105
121
  class KalturaLikeService < KalturaServiceBase
106
122
  def initialize(client)
107
123
  super(client)
108
124
  end
109
125
 
110
- def like(entry_id)
126
+ # @return [bool]
127
+ def check_like_exists(entry_id, user_id=KalturaNotImplemented)
111
128
  kparams = {}
112
129
  client.add_param(kparams, 'entryId', entry_id)
113
- client.queue_service_action_call('like_like', 'like', 'bool', kparams)
130
+ client.add_param(kparams, 'userId', user_id)
131
+ client.queue_service_action_call('like_like', 'checkLikeExists', 'bool', kparams)
114
132
  if (client.is_multirequest)
115
133
  return nil
116
134
  end
117
135
  return client.do_queue()
118
136
  end
119
137
 
120
- def unlike(entry_id)
138
+ # @return [bool]
139
+ def like(entry_id)
121
140
  kparams = {}
122
141
  client.add_param(kparams, 'entryId', entry_id)
123
- client.queue_service_action_call('like_like', 'unlike', 'bool', kparams)
142
+ client.queue_service_action_call('like_like', 'like', 'bool', kparams)
124
143
  if (client.is_multirequest)
125
144
  return nil
126
145
  end
127
146
  return client.do_queue()
128
147
  end
129
148
 
130
- def check_like_exists(entry_id, user_id=KalturaNotImplemented)
149
+ # @return [KalturaLikeListResponse]
150
+ def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
131
151
  kparams = {}
132
- client.add_param(kparams, 'entryId', entry_id)
133
- client.add_param(kparams, 'userId', user_id)
134
- client.queue_service_action_call('like_like', 'checkLikeExists', 'bool', kparams)
152
+ client.add_param(kparams, 'filter', filter)
153
+ client.add_param(kparams, 'pager', pager)
154
+ client.queue_service_action_call('like_like', 'list', 'KalturaLikeListResponse', kparams)
135
155
  if (client.is_multirequest)
136
156
  return nil
137
157
  end
138
158
  return client.do_queue()
139
159
  end
140
160
 
141
- def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
161
+ # @return [bool]
162
+ def unlike(entry_id)
142
163
  kparams = {}
143
- client.add_param(kparams, 'filter', filter)
144
- client.add_param(kparams, 'pager', pager)
145
- client.queue_service_action_call('like_like', 'list', 'KalturaLikeListResponse', kparams)
164
+ client.add_param(kparams, 'entryId', entry_id)
165
+ client.queue_service_action_call('like_like', 'unlike', 'bool', kparams)
146
166
  if (client.is_multirequest)
147
167
  return nil
148
168
  end
@@ -8,7 +8,7 @@
8
8
  # to do with audio, video, and animation what Wiki platfroms allow them to do with
9
9
  # text.
10
10
  #
11
- # Copyright (C) 2006-2015 Kaltura Inc.
11
+ # Copyright (C) 2006-2019 Kaltura Inc.
12
12
  #
13
13
  # This program is free software: you can redistribute it and/or modify
14
14
  # it under the terms of the GNU Affero General Public License as
@@ -51,6 +51,8 @@ module Kaltura
51
51
  AD_CUE_POINT = "adCuePointMetadata.AdCuePoint"
52
52
  ANNOTATION = "annotationMetadata.Annotation"
53
53
  CODE_CUE_POINT = "codeCuePointMetadata.CodeCuePoint"
54
+ ANSWER_CUE_POINT = "quiz.AnswerCuePoint"
55
+ QUESTION_CUE_POINT = "quiz.QuestionCuePoint"
54
56
  THUMB_CUE_POINT = "thumbCuePointMetadata.thumbCuePoint"
55
57
  ENTRY = "1"
56
58
  CATEGORY = "2"
@@ -117,17 +119,39 @@ module Kaltura
117
119
 
118
120
  def from_xml(xml_element)
119
121
  super
120
- self.id = xml_element.elements['id'].text
121
- self.partner_id = xml_element.elements['partnerId'].text
122
- self.metadata_profile_id = xml_element.elements['metadataProfileId'].text
123
- self.metadata_profile_version = xml_element.elements['metadataProfileVersion'].text
124
- self.metadata_object_type = xml_element.elements['metadataObjectType'].text
125
- self.object_id = xml_element.elements['objectId'].text
126
- self.version = xml_element.elements['version'].text
127
- self.created_at = xml_element.elements['createdAt'].text
128
- self.updated_at = xml_element.elements['updatedAt'].text
129
- self.status = xml_element.elements['status'].text
130
- self.xml = xml_element.elements['xml'].text
122
+ if xml_element.elements['id'] != nil
123
+ self.id = xml_element.elements['id'].text
124
+ end
125
+ if xml_element.elements['partnerId'] != nil
126
+ self.partner_id = xml_element.elements['partnerId'].text
127
+ end
128
+ if xml_element.elements['metadataProfileId'] != nil
129
+ self.metadata_profile_id = xml_element.elements['metadataProfileId'].text
130
+ end
131
+ if xml_element.elements['metadataProfileVersion'] != nil
132
+ self.metadata_profile_version = xml_element.elements['metadataProfileVersion'].text
133
+ end
134
+ if xml_element.elements['metadataObjectType'] != nil
135
+ self.metadata_object_type = xml_element.elements['metadataObjectType'].text
136
+ end
137
+ if xml_element.elements['objectId'] != nil
138
+ self.object_id = xml_element.elements['objectId'].text
139
+ end
140
+ if xml_element.elements['version'] != nil
141
+ self.version = xml_element.elements['version'].text
142
+ end
143
+ if xml_element.elements['createdAt'] != nil
144
+ self.created_at = xml_element.elements['createdAt'].text
145
+ end
146
+ if xml_element.elements['updatedAt'] != nil
147
+ self.updated_at = xml_element.elements['updatedAt'].text
148
+ end
149
+ if xml_element.elements['status'] != nil
150
+ self.status = xml_element.elements['status'].text
151
+ end
152
+ if xml_element.elements['xml'] != nil
153
+ self.xml = xml_element.elements['xml'].text
154
+ end
131
155
  end
132
156
 
133
157
  end
@@ -176,21 +200,51 @@ module Kaltura
176
200
 
177
201
  def from_xml(xml_element)
178
202
  super
179
- self.id = xml_element.elements['id'].text
180
- self.partner_id = xml_element.elements['partnerId'].text
181
- self.metadata_object_type = xml_element.elements['metadataObjectType'].text
182
- self.version = xml_element.elements['version'].text
183
- self.name = xml_element.elements['name'].text
184
- self.system_name = xml_element.elements['systemName'].text
185
- self.description = xml_element.elements['description'].text
186
- self.created_at = xml_element.elements['createdAt'].text
187
- self.updated_at = xml_element.elements['updatedAt'].text
188
- self.status = xml_element.elements['status'].text
189
- self.xsd = xml_element.elements['xsd'].text
190
- self.views = xml_element.elements['views'].text
191
- self.xslt = xml_element.elements['xslt'].text
192
- self.create_mode = xml_element.elements['createMode'].text
193
- self.disable_re_indexing = xml_element.elements['disableReIndexing'].text
203
+ if xml_element.elements['id'] != nil
204
+ self.id = xml_element.elements['id'].text
205
+ end
206
+ if xml_element.elements['partnerId'] != nil
207
+ self.partner_id = xml_element.elements['partnerId'].text
208
+ end
209
+ if xml_element.elements['metadataObjectType'] != nil
210
+ self.metadata_object_type = xml_element.elements['metadataObjectType'].text
211
+ end
212
+ if xml_element.elements['version'] != nil
213
+ self.version = xml_element.elements['version'].text
214
+ end
215
+ if xml_element.elements['name'] != nil
216
+ self.name = xml_element.elements['name'].text
217
+ end
218
+ if xml_element.elements['systemName'] != nil
219
+ self.system_name = xml_element.elements['systemName'].text
220
+ end
221
+ if xml_element.elements['description'] != nil
222
+ self.description = xml_element.elements['description'].text
223
+ end
224
+ if xml_element.elements['createdAt'] != nil
225
+ self.created_at = xml_element.elements['createdAt'].text
226
+ end
227
+ if xml_element.elements['updatedAt'] != nil
228
+ self.updated_at = xml_element.elements['updatedAt'].text
229
+ end
230
+ if xml_element.elements['status'] != nil
231
+ self.status = xml_element.elements['status'].text
232
+ end
233
+ if xml_element.elements['xsd'] != nil
234
+ self.xsd = xml_element.elements['xsd'].text
235
+ end
236
+ if xml_element.elements['views'] != nil
237
+ self.views = xml_element.elements['views'].text
238
+ end
239
+ if xml_element.elements['xslt'] != nil
240
+ self.xslt = xml_element.elements['xslt'].text
241
+ end
242
+ if xml_element.elements['createMode'] != nil
243
+ self.create_mode = xml_element.elements['createMode'].text
244
+ end
245
+ if xml_element.elements['disableReIndexing'] != nil
246
+ self.disable_re_indexing = xml_element.elements['disableReIndexing'].text
247
+ end
194
248
  end
195
249
 
196
250
  end
@@ -207,10 +261,18 @@ module Kaltura
207
261
 
208
262
  def from_xml(xml_element)
209
263
  super
210
- self.id = xml_element.elements['id'].text
211
- self.x_path = xml_element.elements['xPath'].text
212
- self.key = xml_element.elements['key'].text
213
- self.label = xml_element.elements['label'].text
264
+ if xml_element.elements['id'] != nil
265
+ self.id = xml_element.elements['id'].text
266
+ end
267
+ if xml_element.elements['xPath'] != nil
268
+ self.x_path = xml_element.elements['xPath'].text
269
+ end
270
+ if xml_element.elements['key'] != nil
271
+ self.key = xml_element.elements['key'].text
272
+ end
273
+ if xml_element.elements['label'] != nil
274
+ self.label = xml_element.elements['label'].text
275
+ end
214
276
  end
215
277
 
216
278
  end
@@ -226,9 +288,15 @@ module Kaltura
226
288
 
227
289
  def from_xml(xml_element)
228
290
  super
229
- self.src_file_url = xml_element.elements['srcFileUrl'].text
230
- self.dest_file_local_path = xml_element.elements['destFileLocalPath'].text
231
- self.metadata_id = xml_element.elements['metadataId'].text
291
+ if xml_element.elements['srcFileUrl'] != nil
292
+ self.src_file_url = xml_element.elements['srcFileUrl'].text
293
+ end
294
+ if xml_element.elements['destFileLocalPath'] != nil
295
+ self.dest_file_local_path = xml_element.elements['destFileLocalPath'].text
296
+ end
297
+ if xml_element.elements['metadataId'] != nil
298
+ self.metadata_id = xml_element.elements['metadataId'].text
299
+ end
232
300
  end
233
301
 
234
302
  end
@@ -239,7 +307,9 @@ module Kaltura
239
307
 
240
308
  def from_xml(xml_element)
241
309
  super
242
- self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaMetadata')
310
+ if xml_element.elements['objects'] != nil
311
+ self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaMetadata')
312
+ end
243
313
  end
244
314
 
245
315
  end
@@ -297,24 +367,60 @@ module Kaltura
297
367
 
298
368
  def from_xml(xml_element)
299
369
  super
300
- self.id_equal = xml_element.elements['idEqual'].text
301
- self.partner_id_equal = xml_element.elements['partnerIdEqual'].text
302
- self.metadata_object_type_equal = xml_element.elements['metadataObjectTypeEqual'].text
303
- self.metadata_object_type_in = xml_element.elements['metadataObjectTypeIn'].text
304
- self.version_equal = xml_element.elements['versionEqual'].text
305
- self.name_equal = xml_element.elements['nameEqual'].text
306
- self.system_name_equal = xml_element.elements['systemNameEqual'].text
307
- self.system_name_in = xml_element.elements['systemNameIn'].text
308
- self.created_at_greater_than_or_equal = xml_element.elements['createdAtGreaterThanOrEqual'].text
309
- self.created_at_less_than_or_equal = xml_element.elements['createdAtLessThanOrEqual'].text
310
- self.updated_at_greater_than_or_equal = xml_element.elements['updatedAtGreaterThanOrEqual'].text
311
- self.updated_at_less_than_or_equal = xml_element.elements['updatedAtLessThanOrEqual'].text
312
- self.status_equal = xml_element.elements['statusEqual'].text
313
- self.status_in = xml_element.elements['statusIn'].text
314
- self.create_mode_equal = xml_element.elements['createModeEqual'].text
315
- self.create_mode_not_equal = xml_element.elements['createModeNotEqual'].text
316
- self.create_mode_in = xml_element.elements['createModeIn'].text
317
- self.create_mode_not_in = xml_element.elements['createModeNotIn'].text
370
+ if xml_element.elements['idEqual'] != nil
371
+ self.id_equal = xml_element.elements['idEqual'].text
372
+ end
373
+ if xml_element.elements['partnerIdEqual'] != nil
374
+ self.partner_id_equal = xml_element.elements['partnerIdEqual'].text
375
+ end
376
+ if xml_element.elements['metadataObjectTypeEqual'] != nil
377
+ self.metadata_object_type_equal = xml_element.elements['metadataObjectTypeEqual'].text
378
+ end
379
+ if xml_element.elements['metadataObjectTypeIn'] != nil
380
+ self.metadata_object_type_in = xml_element.elements['metadataObjectTypeIn'].text
381
+ end
382
+ if xml_element.elements['versionEqual'] != nil
383
+ self.version_equal = xml_element.elements['versionEqual'].text
384
+ end
385
+ if xml_element.elements['nameEqual'] != nil
386
+ self.name_equal = xml_element.elements['nameEqual'].text
387
+ end
388
+ if xml_element.elements['systemNameEqual'] != nil
389
+ self.system_name_equal = xml_element.elements['systemNameEqual'].text
390
+ end
391
+ if xml_element.elements['systemNameIn'] != nil
392
+ self.system_name_in = xml_element.elements['systemNameIn'].text
393
+ end
394
+ if xml_element.elements['createdAtGreaterThanOrEqual'] != nil
395
+ self.created_at_greater_than_or_equal = xml_element.elements['createdAtGreaterThanOrEqual'].text
396
+ end
397
+ if xml_element.elements['createdAtLessThanOrEqual'] != nil
398
+ self.created_at_less_than_or_equal = xml_element.elements['createdAtLessThanOrEqual'].text
399
+ end
400
+ if xml_element.elements['updatedAtGreaterThanOrEqual'] != nil
401
+ self.updated_at_greater_than_or_equal = xml_element.elements['updatedAtGreaterThanOrEqual'].text
402
+ end
403
+ if xml_element.elements['updatedAtLessThanOrEqual'] != nil
404
+ self.updated_at_less_than_or_equal = xml_element.elements['updatedAtLessThanOrEqual'].text
405
+ end
406
+ if xml_element.elements['statusEqual'] != nil
407
+ self.status_equal = xml_element.elements['statusEqual'].text
408
+ end
409
+ if xml_element.elements['statusIn'] != nil
410
+ self.status_in = xml_element.elements['statusIn'].text
411
+ end
412
+ if xml_element.elements['createModeEqual'] != nil
413
+ self.create_mode_equal = xml_element.elements['createModeEqual'].text
414
+ end
415
+ if xml_element.elements['createModeNotEqual'] != nil
416
+ self.create_mode_not_equal = xml_element.elements['createModeNotEqual'].text
417
+ end
418
+ if xml_element.elements['createModeIn'] != nil
419
+ self.create_mode_in = xml_element.elements['createModeIn'].text
420
+ end
421
+ if xml_element.elements['createModeNotIn'] != nil
422
+ self.create_mode_not_in = xml_element.elements['createModeNotIn'].text
423
+ end
318
424
  end
319
425
 
320
426
  end
@@ -325,7 +431,9 @@ module Kaltura
325
431
 
326
432
  def from_xml(xml_element)
327
433
  super
328
- self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaMetadataProfileField')
434
+ if xml_element.elements['objects'] != nil
435
+ self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaMetadataProfileField')
436
+ end
329
437
  end
330
438
 
331
439
  end
@@ -336,7 +444,27 @@ module Kaltura
336
444
 
337
445
  def from_xml(xml_element)
338
446
  super
339
- self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaMetadataProfile')
447
+ if xml_element.elements['objects'] != nil
448
+ self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaMetadataProfile')
449
+ end
450
+ end
451
+
452
+ end
453
+
454
+ # Advanced metadata configuration for entry replacement process
455
+ class KalturaMetadataReplacementOptionsItem < KalturaPluginReplacementOptionsItem
456
+ # If true custom-metadata transferred to temp entry on entry replacement
457
+ attr_accessor :should_copy_metadata
458
+
459
+ def should_copy_metadata=(val)
460
+ @should_copy_metadata = to_b(val)
461
+ end
462
+
463
+ def from_xml(xml_element)
464
+ super
465
+ if xml_element.elements['shouldCopyMetadata'] != nil
466
+ self.should_copy_metadata = xml_element.elements['shouldCopyMetadata'].text
467
+ end
340
468
  end
341
469
 
342
470
  end
@@ -351,10 +479,10 @@ module Kaltura
351
479
  end
352
480
 
353
481
  class KalturaTransformMetadataJobData < KalturaJobData
354
- attr_accessor :src_xsl_path
482
+ attr_accessor :src_xsl
355
483
  attr_accessor :src_version
356
484
  attr_accessor :dest_version
357
- attr_accessor :dest_xsd_path
485
+ attr_accessor :dest_xsd
358
486
  attr_accessor :metadata_profile_id
359
487
 
360
488
  def src_version=(val)
@@ -369,11 +497,21 @@ module Kaltura
369
497
 
370
498
  def from_xml(xml_element)
371
499
  super
372
- self.src_xsl_path = xml_element.elements['srcXslPath'].text
373
- self.src_version = xml_element.elements['srcVersion'].text
374
- self.dest_version = xml_element.elements['destVersion'].text
375
- self.dest_xsd_path = xml_element.elements['destXsdPath'].text
376
- self.metadata_profile_id = xml_element.elements['metadataProfileId'].text
500
+ if xml_element.elements['srcXsl'] != nil
501
+ self.src_xsl = KalturaClientBase.object_from_xml(xml_element.elements['srcXsl'], 'KalturaFileContainer')
502
+ end
503
+ if xml_element.elements['srcVersion'] != nil
504
+ self.src_version = xml_element.elements['srcVersion'].text
505
+ end
506
+ if xml_element.elements['destVersion'] != nil
507
+ self.dest_version = xml_element.elements['destVersion'].text
508
+ end
509
+ if xml_element.elements['destXsd'] != nil
510
+ self.dest_xsd = KalturaClientBase.object_from_xml(xml_element.elements['destXsd'], 'KalturaFileContainer')
511
+ end
512
+ if xml_element.elements['metadataProfileId'] != nil
513
+ self.metadata_profile_id = xml_element.elements['metadataProfileId'].text
514
+ end
377
515
  end
378
516
 
379
517
  end
@@ -383,13 +521,10 @@ module Kaltura
383
521
  # 1. Slashed xPath, e.g. /metadata/myElementName
384
522
  # 2. Using local-name function, e.g. /[local-name()='metadata']/[local-name()='myElementName']
385
523
  # 3. Using only the field name, e.g. myElementName, it will be searched as //myElementName
386
- #
387
524
  attr_accessor :x_path
388
525
  # Metadata profile id
389
- #
390
526
  attr_accessor :profile_id
391
527
  # Metadata profile system name
392
- #
393
528
  attr_accessor :profile_system_name
394
529
 
395
530
  def profile_id=(val)
@@ -398,9 +533,15 @@ module Kaltura
398
533
 
399
534
  def from_xml(xml_element)
400
535
  super
401
- self.x_path = xml_element.elements['xPath'].text
402
- self.profile_id = xml_element.elements['profileId'].text
403
- self.profile_system_name = xml_element.elements['profileSystemName'].text
536
+ if xml_element.elements['xPath'] != nil
537
+ self.x_path = xml_element.elements['xPath'].text
538
+ end
539
+ if xml_element.elements['profileId'] != nil
540
+ self.profile_id = xml_element.elements['profileId'].text
541
+ end
542
+ if xml_element.elements['profileSystemName'] != nil
543
+ self.profile_system_name = xml_element.elements['profileSystemName'].text
544
+ end
404
545
  end
405
546
 
406
547
  end
@@ -411,7 +552,9 @@ module Kaltura
411
552
 
412
553
  def from_xml(xml_element)
413
554
  super
414
- self.field = xml_element.elements['field'].text
555
+ if xml_element.elements['field'] != nil
556
+ self.field = xml_element.elements['field'].text
557
+ end
415
558
  end
416
559
 
417
560
  end
@@ -421,13 +564,10 @@ module Kaltura
421
564
  # 1. Slashed xPath, e.g. /metadata/myElementName
422
565
  # 2. Using local-name function, e.g. /[local-name()='metadata']/[local-name()='myElementName']
423
566
  # 3. Using only the field name, e.g. myElementName, it will be searched as //myElementName
424
- #
425
567
  attr_accessor :x_path
426
568
  # Metadata profile id
427
- #
428
569
  attr_accessor :profile_id
429
570
  # Metadata profile system name
430
- #
431
571
  attr_accessor :profile_system_name
432
572
 
433
573
  def profile_id=(val)
@@ -436,9 +576,15 @@ module Kaltura
436
576
 
437
577
  def from_xml(xml_element)
438
578
  super
439
- self.x_path = xml_element.elements['xPath'].text
440
- self.profile_id = xml_element.elements['profileId'].text
441
- self.profile_system_name = xml_element.elements['profileSystemName'].text
579
+ if xml_element.elements['xPath'] != nil
580
+ self.x_path = xml_element.elements['xPath'].text
581
+ end
582
+ if xml_element.elements['profileId'] != nil
583
+ self.profile_id = xml_element.elements['profileId'].text
584
+ end
585
+ if xml_element.elements['profileSystemName'] != nil
586
+ self.profile_system_name = xml_element.elements['profileSystemName'].text
587
+ end
442
588
  end
443
589
 
444
590
  end
@@ -446,11 +592,11 @@ module Kaltura
446
592
  class KalturaMetadataBaseFilter < KalturaRelatedFilter
447
593
  attr_accessor :partner_id_equal
448
594
  attr_accessor :metadata_profile_id_equal
595
+ attr_accessor :metadata_profile_id_in
449
596
  attr_accessor :metadata_profile_version_equal
450
597
  attr_accessor :metadata_profile_version_greater_than_or_equal
451
598
  attr_accessor :metadata_profile_version_less_than_or_equal
452
599
  # When null, default is KalturaMetadataObjectType::ENTRY
453
- #
454
600
  attr_accessor :metadata_object_type_equal
455
601
  attr_accessor :object_id_equal
456
602
  attr_accessor :object_id_in
@@ -506,23 +652,60 @@ module Kaltura
506
652
 
507
653
  def from_xml(xml_element)
508
654
  super
509
- self.partner_id_equal = xml_element.elements['partnerIdEqual'].text
510
- self.metadata_profile_id_equal = xml_element.elements['metadataProfileIdEqual'].text
511
- self.metadata_profile_version_equal = xml_element.elements['metadataProfileVersionEqual'].text
512
- self.metadata_profile_version_greater_than_or_equal = xml_element.elements['metadataProfileVersionGreaterThanOrEqual'].text
513
- self.metadata_profile_version_less_than_or_equal = xml_element.elements['metadataProfileVersionLessThanOrEqual'].text
514
- self.metadata_object_type_equal = xml_element.elements['metadataObjectTypeEqual'].text
515
- self.object_id_equal = xml_element.elements['objectIdEqual'].text
516
- self.object_id_in = xml_element.elements['objectIdIn'].text
517
- self.version_equal = xml_element.elements['versionEqual'].text
518
- self.version_greater_than_or_equal = xml_element.elements['versionGreaterThanOrEqual'].text
519
- self.version_less_than_or_equal = xml_element.elements['versionLessThanOrEqual'].text
520
- self.created_at_greater_than_or_equal = xml_element.elements['createdAtGreaterThanOrEqual'].text
521
- self.created_at_less_than_or_equal = xml_element.elements['createdAtLessThanOrEqual'].text
522
- self.updated_at_greater_than_or_equal = xml_element.elements['updatedAtGreaterThanOrEqual'].text
523
- self.updated_at_less_than_or_equal = xml_element.elements['updatedAtLessThanOrEqual'].text
524
- self.status_equal = xml_element.elements['statusEqual'].text
525
- self.status_in = xml_element.elements['statusIn'].text
655
+ if xml_element.elements['partnerIdEqual'] != nil
656
+ self.partner_id_equal = xml_element.elements['partnerIdEqual'].text
657
+ end
658
+ if xml_element.elements['metadataProfileIdEqual'] != nil
659
+ self.metadata_profile_id_equal = xml_element.elements['metadataProfileIdEqual'].text
660
+ end
661
+ if xml_element.elements['metadataProfileIdIn'] != nil
662
+ self.metadata_profile_id_in = xml_element.elements['metadataProfileIdIn'].text
663
+ end
664
+ if xml_element.elements['metadataProfileVersionEqual'] != nil
665
+ self.metadata_profile_version_equal = xml_element.elements['metadataProfileVersionEqual'].text
666
+ end
667
+ if xml_element.elements['metadataProfileVersionGreaterThanOrEqual'] != nil
668
+ self.metadata_profile_version_greater_than_or_equal = xml_element.elements['metadataProfileVersionGreaterThanOrEqual'].text
669
+ end
670
+ if xml_element.elements['metadataProfileVersionLessThanOrEqual'] != nil
671
+ self.metadata_profile_version_less_than_or_equal = xml_element.elements['metadataProfileVersionLessThanOrEqual'].text
672
+ end
673
+ if xml_element.elements['metadataObjectTypeEqual'] != nil
674
+ self.metadata_object_type_equal = xml_element.elements['metadataObjectTypeEqual'].text
675
+ end
676
+ if xml_element.elements['objectIdEqual'] != nil
677
+ self.object_id_equal = xml_element.elements['objectIdEqual'].text
678
+ end
679
+ if xml_element.elements['objectIdIn'] != nil
680
+ self.object_id_in = xml_element.elements['objectIdIn'].text
681
+ end
682
+ if xml_element.elements['versionEqual'] != nil
683
+ self.version_equal = xml_element.elements['versionEqual'].text
684
+ end
685
+ if xml_element.elements['versionGreaterThanOrEqual'] != nil
686
+ self.version_greater_than_or_equal = xml_element.elements['versionGreaterThanOrEqual'].text
687
+ end
688
+ if xml_element.elements['versionLessThanOrEqual'] != nil
689
+ self.version_less_than_or_equal = xml_element.elements['versionLessThanOrEqual'].text
690
+ end
691
+ if xml_element.elements['createdAtGreaterThanOrEqual'] != nil
692
+ self.created_at_greater_than_or_equal = xml_element.elements['createdAtGreaterThanOrEqual'].text
693
+ end
694
+ if xml_element.elements['createdAtLessThanOrEqual'] != nil
695
+ self.created_at_less_than_or_equal = xml_element.elements['createdAtLessThanOrEqual'].text
696
+ end
697
+ if xml_element.elements['updatedAtGreaterThanOrEqual'] != nil
698
+ self.updated_at_greater_than_or_equal = xml_element.elements['updatedAtGreaterThanOrEqual'].text
699
+ end
700
+ if xml_element.elements['updatedAtLessThanOrEqual'] != nil
701
+ self.updated_at_less_than_or_equal = xml_element.elements['updatedAtLessThanOrEqual'].text
702
+ end
703
+ if xml_element.elements['statusEqual'] != nil
704
+ self.status_equal = xml_element.elements['statusEqual'].text
705
+ end
706
+ if xml_element.elements['statusIn'] != nil
707
+ self.status_in = xml_element.elements['statusIn'].text
708
+ end
526
709
  end
527
710
 
528
711
  end
@@ -532,13 +715,10 @@ module Kaltura
532
715
  # 1. Slashed xPath, e.g. /metadata/myElementName
533
716
  # 2. Using local-name function, e.g. /[local-name()='metadata']/[local-name()='myElementName']
534
717
  # 3. Using only the field name, e.g. myElementName, it will be searched as //myElementName
535
- #
536
718
  attr_accessor :x_path
537
719
  # Metadata profile id
538
- #
539
720
  attr_accessor :profile_id
540
721
  # Metadata profile system name
541
- #
542
722
  attr_accessor :profile_system_name
543
723
  attr_accessor :version_a
544
724
  attr_accessor :version_b
@@ -549,11 +729,21 @@ module Kaltura
549
729
 
550
730
  def from_xml(xml_element)
551
731
  super
552
- self.x_path = xml_element.elements['xPath'].text
553
- self.profile_id = xml_element.elements['profileId'].text
554
- self.profile_system_name = xml_element.elements['profileSystemName'].text
555
- self.version_a = xml_element.elements['versionA'].text
556
- self.version_b = xml_element.elements['versionB'].text
732
+ if xml_element.elements['xPath'] != nil
733
+ self.x_path = xml_element.elements['xPath'].text
734
+ end
735
+ if xml_element.elements['profileId'] != nil
736
+ self.profile_id = xml_element.elements['profileId'].text
737
+ end
738
+ if xml_element.elements['profileSystemName'] != nil
739
+ self.profile_system_name = xml_element.elements['profileSystemName'].text
740
+ end
741
+ if xml_element.elements['versionA'] != nil
742
+ self.version_a = xml_element.elements['versionA'].text
743
+ end
744
+ if xml_element.elements['versionB'] != nil
745
+ self.version_b = xml_element.elements['versionB'].text
746
+ end
557
747
  end
558
748
 
559
749
  end
@@ -577,8 +767,42 @@ module Kaltura
577
767
 
578
768
  def from_xml(xml_element)
579
769
  super
580
- self.metadata_profile_id = xml_element.elements['metadataProfileId'].text
581
- self.order_by = xml_element.elements['orderBy'].text
770
+ if xml_element.elements['metadataProfileId'] != nil
771
+ self.metadata_profile_id = xml_element.elements['metadataProfileId'].text
772
+ end
773
+ if xml_element.elements['orderBy'] != nil
774
+ self.order_by = xml_element.elements['orderBy'].text
775
+ end
776
+ end
777
+
778
+ end
779
+
780
+ class KalturaMetadataField < KalturaStringField
781
+ # May contain the full xpath to the field in three formats
782
+ # 1. Slashed xPath, e.g. /metadata/myElementName
783
+ # 2. Using local-name function, e.g. /[local-name()='metadata']/[local-name()='myElementName']
784
+ # 3. Using only the field name, e.g. myElementName, it will be searched as //myElementName
785
+ attr_accessor :x_path
786
+ # Metadata profile id
787
+ attr_accessor :profile_id
788
+ # Metadata profile system name
789
+ attr_accessor :profile_system_name
790
+
791
+ def profile_id=(val)
792
+ @profile_id = val.to_i
793
+ end
794
+
795
+ def from_xml(xml_element)
796
+ super
797
+ if xml_element.elements['xPath'] != nil
798
+ self.x_path = xml_element.elements['xPath'].text
799
+ end
800
+ if xml_element.elements['profileId'] != nil
801
+ self.profile_id = xml_element.elements['profileId'].text
802
+ end
803
+ if xml_element.elements['profileSystemName'] != nil
804
+ self.profile_system_name = xml_element.elements['profileSystemName'].text
805
+ end
582
806
  end
583
807
 
584
808
  end
@@ -594,14 +818,13 @@ module Kaltura
594
818
 
595
819
 
596
820
  # Metadata service
597
- #
598
821
  class KalturaMetadataService < KalturaServiceBase
599
822
  def initialize(client)
600
823
  super(client)
601
824
  end
602
825
 
603
826
  # Allows you to add a metadata object and metadata content associated with Kaltura object
604
- #
827
+ # @return [KalturaMetadata]
605
828
  def add(metadata_profile_id, object_type, object_id, xml_data)
606
829
  kparams = {}
607
830
  client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
@@ -615,8 +838,24 @@ module Kaltura
615
838
  return client.do_queue()
616
839
  end
617
840
 
841
+ # Allows you to add a metadata XML data from remote URL.
842
+ # Enables different permissions than addFromUrl action.
843
+ # @return [KalturaMetadata]
844
+ def add_from_bulk(metadata_profile_id, object_type, object_id, url)
845
+ kparams = {}
846
+ client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
847
+ client.add_param(kparams, 'objectType', object_type)
848
+ client.add_param(kparams, 'objectId', object_id)
849
+ client.add_param(kparams, 'url', url)
850
+ client.queue_service_action_call('metadata_metadata', 'addFromBulk', 'KalturaMetadata', kparams)
851
+ if (client.is_multirequest)
852
+ return nil
853
+ end
854
+ return client.do_queue()
855
+ end
856
+
618
857
  # Allows you to add a metadata object and metadata file associated with Kaltura object
619
- #
858
+ # @return [KalturaMetadata]
620
859
  def add_from_file(metadata_profile_id, object_type, object_id, xml_file)
621
860
  kparams = {}
622
861
  kfiles = {}
@@ -631,8 +870,8 @@ module Kaltura
631
870
  return client.do_queue()
632
871
  end
633
872
 
634
- # Allows you to add a metadata xml data from remote URL
635
- #
873
+ # Allows you to add a metadata XML data from remote URL
874
+ # @return [KalturaMetadata]
636
875
  def add_from_url(metadata_profile_id, object_type, object_id, url)
637
876
  kparams = {}
638
877
  client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
@@ -646,16 +885,12 @@ module Kaltura
646
885
  return client.do_queue()
647
886
  end
648
887
 
649
- # Allows you to add a metadata xml data from remote URL.
650
- # Enables different permissions than addFromUrl action.
651
- #
652
- def add_from_bulk(metadata_profile_id, object_type, object_id, url)
888
+ # Delete an existing metadata
889
+ # @return []
890
+ def delete(id)
653
891
  kparams = {}
654
- client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
655
- client.add_param(kparams, 'objectType', object_type)
656
- client.add_param(kparams, 'objectId', object_id)
657
- client.add_param(kparams, 'url', url)
658
- client.queue_service_action_call('metadata_metadata', 'addFromBulk', 'KalturaMetadata', kparams)
892
+ client.add_param(kparams, 'id', id)
893
+ client.queue_service_action_call('metadata_metadata', 'delete', '', kparams)
659
894
  if (client.is_multirequest)
660
895
  return nil
661
896
  end
@@ -663,7 +898,7 @@ module Kaltura
663
898
  end
664
899
 
665
900
  # Retrieve a metadata object by id
666
- #
901
+ # @return [KalturaMetadata]
667
902
  def get(id)
668
903
  kparams = {}
669
904
  client.add_param(kparams, 'id', id)
@@ -674,28 +909,27 @@ module Kaltura
674
909
  return client.do_queue()
675
910
  end
676
911
 
677
- # Update an existing metadata object with new XML content
678
- #
679
- def update(id, xml_data=KalturaNotImplemented, version=KalturaNotImplemented)
912
+ # Index metadata by id, will also index the related object
913
+ # @return [int]
914
+ def index(id, should_update)
680
915
  kparams = {}
681
916
  client.add_param(kparams, 'id', id)
682
- client.add_param(kparams, 'xmlData', xml_data)
683
- client.add_param(kparams, 'version', version)
684
- client.queue_service_action_call('metadata_metadata', 'update', 'KalturaMetadata', kparams)
917
+ client.add_param(kparams, 'shouldUpdate', should_update)
918
+ client.queue_service_action_call('metadata_metadata', 'index', 'int', kparams)
685
919
  if (client.is_multirequest)
686
920
  return nil
687
921
  end
688
922
  return client.do_queue()
689
923
  end
690
924
 
691
- # Update an existing metadata object with new XML file
692
- #
693
- def update_from_file(id, xml_file=KalturaNotImplemented)
925
+ # Mark existing metadata as invalid
926
+ # Used by batch metadata transform
927
+ # @return []
928
+ def invalidate(id, version=KalturaNotImplemented)
694
929
  kparams = {}
695
- kfiles = {}
696
930
  client.add_param(kparams, 'id', id)
697
- client.add_param(kfiles, 'xmlFile', xml_file)
698
- client.queue_service_action_call('metadata_metadata', 'updateFromFile', 'KalturaMetadata', kparams, kfiles)
931
+ client.add_param(kparams, 'version', version)
932
+ client.queue_service_action_call('metadata_metadata', 'invalidate', '', kparams)
699
933
  if (client.is_multirequest)
700
934
  return nil
701
935
  end
@@ -703,7 +937,7 @@ module Kaltura
703
937
  end
704
938
 
705
939
  # List metadata objects by filter and pager
706
- #
940
+ # @return [KalturaMetadataListResponse]
707
941
  def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
708
942
  kparams = {}
709
943
  client.add_param(kparams, 'filter', filter)
@@ -715,56 +949,45 @@ module Kaltura
715
949
  return client.do_queue()
716
950
  end
717
951
 
718
- # Delete an existing metadata
719
- #
720
- def delete(id)
952
+ # Serves metadata XML file
953
+ # @return [file]
954
+ def serve(id)
721
955
  kparams = {}
722
956
  client.add_param(kparams, 'id', id)
723
- client.queue_service_action_call('metadata_metadata', 'delete', '', kparams)
724
- if (client.is_multirequest)
725
- return nil
726
- end
727
- return client.do_queue()
957
+ client.queue_service_action_call('metadata_metadata', 'serve', 'file', kparams)
958
+ return client.get_serve_url()
728
959
  end
729
960
 
730
- # Mark existing metadata as invalid
731
- # Used by batch metadata transform
732
- #
733
- def invalidate(id, version=KalturaNotImplemented)
961
+ # Update an existing metadata object with new XML content
962
+ # @return [KalturaMetadata]
963
+ def update(id, xml_data=KalturaNotImplemented, version=KalturaNotImplemented)
734
964
  kparams = {}
735
965
  client.add_param(kparams, 'id', id)
966
+ client.add_param(kparams, 'xmlData', xml_data)
736
967
  client.add_param(kparams, 'version', version)
737
- client.queue_service_action_call('metadata_metadata', 'invalidate', '', kparams)
968
+ client.queue_service_action_call('metadata_metadata', 'update', 'KalturaMetadata', kparams)
738
969
  if (client.is_multirequest)
739
970
  return nil
740
971
  end
741
972
  return client.do_queue()
742
973
  end
743
974
 
744
- # Index metadata by id, will also index the related object
745
- #
746
- def index(id, should_update)
975
+ # Update an existing metadata object with new XML file
976
+ # @return [KalturaMetadata]
977
+ def update_from_file(id, xml_file=KalturaNotImplemented)
747
978
  kparams = {}
979
+ kfiles = {}
748
980
  client.add_param(kparams, 'id', id)
749
- client.add_param(kparams, 'shouldUpdate', should_update)
750
- client.queue_service_action_call('metadata_metadata', 'index', 'int', kparams)
981
+ client.add_param(kfiles, 'xmlFile', xml_file)
982
+ client.queue_service_action_call('metadata_metadata', 'updateFromFile', 'KalturaMetadata', kparams, kfiles)
751
983
  if (client.is_multirequest)
752
984
  return nil
753
985
  end
754
986
  return client.do_queue()
755
987
  end
756
988
 
757
- # Serves metadata XML file
758
- #
759
- def serve(id)
760
- kparams = {}
761
- client.add_param(kparams, 'id', id)
762
- client.queue_service_action_call('metadata_metadata', 'serve', 'file', kparams)
763
- return client.get_serve_url()
764
- end
765
-
766
989
  # Action transforms current metadata object XML using a provided XSL.
767
- #
990
+ # @return [KalturaMetadata]
768
991
  def update_from_xsl(id, xsl_file)
769
992
  kparams = {}
770
993
  kfiles = {}
@@ -779,14 +1002,13 @@ module Kaltura
779
1002
  end
780
1003
 
781
1004
  # Metadata Profile service
782
- #
783
1005
  class KalturaMetadataProfileService < KalturaServiceBase
784
1006
  def initialize(client)
785
1007
  super(client)
786
1008
  end
787
1009
 
788
1010
  # Allows you to add a metadata profile object and metadata profile content associated with Kaltura object type
789
- #
1011
+ # @return [KalturaMetadataProfile]
790
1012
  def add(metadata_profile, xsd_data, views_data=KalturaNotImplemented)
791
1013
  kparams = {}
792
1014
  client.add_param(kparams, 'metadataProfile', metadata_profile)
@@ -800,7 +1022,7 @@ module Kaltura
800
1022
  end
801
1023
 
802
1024
  # Allows you to add a metadata profile object and metadata profile file associated with Kaltura object type
803
- #
1025
+ # @return [KalturaMetadataProfile]
804
1026
  def add_from_file(metadata_profile, xsd_file, views_file=KalturaNotImplemented)
805
1027
  kparams = {}
806
1028
  kfiles = {}
@@ -814,27 +1036,24 @@ module Kaltura
814
1036
  return client.do_queue()
815
1037
  end
816
1038
 
817
- # Retrieve a metadata profile object by id
818
- #
819
- def get(id)
1039
+ # Delete an existing metadata profile
1040
+ # @return []
1041
+ def delete(id)
820
1042
  kparams = {}
821
1043
  client.add_param(kparams, 'id', id)
822
- client.queue_service_action_call('metadata_metadataprofile', 'get', 'KalturaMetadataProfile', kparams)
1044
+ client.queue_service_action_call('metadata_metadataprofile', 'delete', '', kparams)
823
1045
  if (client.is_multirequest)
824
1046
  return nil
825
1047
  end
826
1048
  return client.do_queue()
827
1049
  end
828
1050
 
829
- # Update an existing metadata object
830
- #
831
- def update(id, metadata_profile, xsd_data=KalturaNotImplemented, views_data=KalturaNotImplemented)
1051
+ # Retrieve a metadata profile object by id
1052
+ # @return [KalturaMetadataProfile]
1053
+ def get(id)
832
1054
  kparams = {}
833
1055
  client.add_param(kparams, 'id', id)
834
- client.add_param(kparams, 'metadataProfile', metadata_profile)
835
- client.add_param(kparams, 'xsdData', xsd_data)
836
- client.add_param(kparams, 'viewsData', views_data)
837
- client.queue_service_action_call('metadata_metadataprofile', 'update', 'KalturaMetadataProfile', kparams)
1056
+ client.queue_service_action_call('metadata_metadataprofile', 'get', 'KalturaMetadataProfile', kparams)
838
1057
  if (client.is_multirequest)
839
1058
  return nil
840
1059
  end
@@ -842,7 +1061,7 @@ module Kaltura
842
1061
  end
843
1062
 
844
1063
  # List metadata profile objects by filter and pager
845
- #
1064
+ # @return [KalturaMetadataProfileListResponse]
846
1065
  def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
847
1066
  kparams = {}
848
1067
  client.add_param(kparams, 'filter', filter)
@@ -855,7 +1074,7 @@ module Kaltura
855
1074
  end
856
1075
 
857
1076
  # List metadata profile fields by metadata profile id
858
- #
1077
+ # @return [KalturaMetadataProfileFieldListResponse]
859
1078
  def list_fields(metadata_profile_id)
860
1079
  kparams = {}
861
1080
  client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
@@ -866,25 +1085,46 @@ module Kaltura
866
1085
  return client.do_queue()
867
1086
  end
868
1087
 
869
- # Delete an existing metadata profile
870
- #
871
- def delete(id)
1088
+ # Update an existing metadata object definition file
1089
+ # @return [KalturaMetadataProfile]
1090
+ def revert(id, to_version)
872
1091
  kparams = {}
873
1092
  client.add_param(kparams, 'id', id)
874
- client.queue_service_action_call('metadata_metadataprofile', 'delete', '', kparams)
1093
+ client.add_param(kparams, 'toVersion', to_version)
1094
+ client.queue_service_action_call('metadata_metadataprofile', 'revert', 'KalturaMetadataProfile', kparams)
875
1095
  if (client.is_multirequest)
876
1096
  return nil
877
1097
  end
878
1098
  return client.do_queue()
879
1099
  end
880
1100
 
881
- # Update an existing metadata object definition file
882
- #
883
- def revert(id, to_version)
1101
+ # Serves metadata profile XSD file
1102
+ # @return [file]
1103
+ def serve(id)
884
1104
  kparams = {}
885
1105
  client.add_param(kparams, 'id', id)
886
- client.add_param(kparams, 'toVersion', to_version)
887
- client.queue_service_action_call('metadata_metadataprofile', 'revert', 'KalturaMetadataProfile', kparams)
1106
+ client.queue_service_action_call('metadata_metadataprofile', 'serve', 'file', kparams)
1107
+ return client.get_serve_url()
1108
+ end
1109
+
1110
+ # Serves metadata profile view file
1111
+ # @return [file]
1112
+ def serve_view(id)
1113
+ kparams = {}
1114
+ client.add_param(kparams, 'id', id)
1115
+ client.queue_service_action_call('metadata_metadataprofile', 'serveView', 'file', kparams)
1116
+ return client.get_serve_url()
1117
+ end
1118
+
1119
+ # Update an existing metadata object
1120
+ # @return [KalturaMetadataProfile]
1121
+ def update(id, metadata_profile, xsd_data=KalturaNotImplemented, views_data=KalturaNotImplemented)
1122
+ kparams = {}
1123
+ client.add_param(kparams, 'id', id)
1124
+ client.add_param(kparams, 'metadataProfile', metadata_profile)
1125
+ client.add_param(kparams, 'xsdData', xsd_data)
1126
+ client.add_param(kparams, 'viewsData', views_data)
1127
+ client.queue_service_action_call('metadata_metadataprofile', 'update', 'KalturaMetadataProfile', kparams)
888
1128
  if (client.is_multirequest)
889
1129
  return nil
890
1130
  end
@@ -892,7 +1132,7 @@ module Kaltura
892
1132
  end
893
1133
 
894
1134
  # Update an existing metadata object definition file
895
- #
1135
+ # @return [KalturaMetadataProfile]
896
1136
  def update_definition_from_file(id, xsd_file)
897
1137
  kparams = {}
898
1138
  kfiles = {}
@@ -905,51 +1145,33 @@ module Kaltura
905
1145
  return client.do_queue()
906
1146
  end
907
1147
 
908
- # Update an existing metadata object views file
909
- #
910
- def update_views_from_file(id, views_file)
1148
+ # Update an existing metadata object XSLT file
1149
+ # @return [KalturaMetadataProfile]
1150
+ def update_transformation_from_file(id, xslt_file)
911
1151
  kparams = {}
912
1152
  kfiles = {}
913
1153
  client.add_param(kparams, 'id', id)
914
- client.add_param(kfiles, 'viewsFile', views_file)
915
- client.queue_service_action_call('metadata_metadataprofile', 'updateViewsFromFile', 'KalturaMetadataProfile', kparams, kfiles)
1154
+ client.add_param(kfiles, 'xsltFile', xslt_file)
1155
+ client.queue_service_action_call('metadata_metadataprofile', 'updateTransformationFromFile', 'KalturaMetadataProfile', kparams, kfiles)
916
1156
  if (client.is_multirequest)
917
1157
  return nil
918
1158
  end
919
1159
  return client.do_queue()
920
1160
  end
921
1161
 
922
- # Update an existing metadata object xslt file
923
- #
924
- def update_transformation_from_file(id, xslt_file)
1162
+ # Update an existing metadata object views file
1163
+ # @return [KalturaMetadataProfile]
1164
+ def update_views_from_file(id, views_file)
925
1165
  kparams = {}
926
1166
  kfiles = {}
927
1167
  client.add_param(kparams, 'id', id)
928
- client.add_param(kfiles, 'xsltFile', xslt_file)
929
- client.queue_service_action_call('metadata_metadataprofile', 'updateTransformationFromFile', 'KalturaMetadataProfile', kparams, kfiles)
1168
+ client.add_param(kfiles, 'viewsFile', views_file)
1169
+ client.queue_service_action_call('metadata_metadataprofile', 'updateViewsFromFile', 'KalturaMetadataProfile', kparams, kfiles)
930
1170
  if (client.is_multirequest)
931
1171
  return nil
932
1172
  end
933
1173
  return client.do_queue()
934
1174
  end
935
-
936
- # Serves metadata profile XSD file
937
- #
938
- def serve(id)
939
- kparams = {}
940
- client.add_param(kparams, 'id', id)
941
- client.queue_service_action_call('metadata_metadataprofile', 'serve', 'file', kparams)
942
- return client.get_serve_url()
943
- end
944
-
945
- # Serves metadata profile view file
946
- #
947
- def serve_view(id)
948
- kparams = {}
949
- client.add_param(kparams, 'id', id)
950
- client.queue_service_action_call('metadata_metadataprofile', 'serveView', 'file', kparams)
951
- return client.get_serve_url()
952
- end
953
1175
  end
954
1176
 
955
1177
  class KalturaClient < KalturaClientBase