Class: Kaltura::KalturaEntryVendorTaskService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_reach_client_plugin.rb

Overview

Entry Vendor Task Service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaEntryVendorTaskService

Returns a new instance of KalturaEntryVendorTaskService.



2025
2026
2027
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2025

def initialize(client)
	super(client)
end

Instance Method Details

#abort(id, abort_reason = KalturaNotImplemented) ⇒ KalturaEntryVendorTask

Cancel entry task. will only occur for task in PENDING or PENDING_MODERATION status

Returns:



2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2031

def abort(id, abort_reason=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'abortReason', abort_reason)
	client.queue_service_action_call('reach_entryvendortask', 'abort', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#add(entry_vendor_task) ⇒ KalturaEntryVendorTask

Allows you to add a entry vendor task

Returns:



2044
2045
2046
2047
2048
2049
2050
2051
2052
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2044

def add(entry_vendor_task)
	kparams = {}
	client.add_param(kparams, 'entryVendorTask', entry_vendor_task)
	client.queue_service_action_call('reach_entryvendortask', 'add', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#approve(id) ⇒ KalturaEntryVendorTask

Approve entry vendor task for execution.

Returns:



2056
2057
2058
2059
2060
2061
2062
2063
2064
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2056

def approve(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('reach_entryvendortask', 'approve', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#export_to_csv(filter) ⇒ string

add batch job that sends an email with a link to download an updated CSV that contains list of users

Returns:

  • (string) 


2068
2069
2070
2071
2072
2073
2074
2075
2076
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2068

def export_to_csv(filter)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.queue_service_action_call('reach_entryvendortask', 'exportToCsv', 'string', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#extend_access_key(id) ⇒ KalturaEntryVendorTask

Extend access key in case the existing one has expired.

Returns:



2080
2081
2082
2083
2084
2085
2086
2087
2088
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2080

def extend_access_key(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('reach_entryvendortask', 'extendAccessKey', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get(id) ⇒ KalturaEntryVendorTask

Retrieve specific entry vendor task by id

Returns:



2092
2093
2094
2095
2096
2097
2098
2099
2100
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2092

def get(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('reach_entryvendortask', 'get', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get_jobs(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaEntryVendorTaskListResponse

get KalturaEntryVendorTask objects for specific vendor partner

Returns:



2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2104

def get_jobs(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('reach_entryvendortask', 'getJobs', 'KalturaEntryVendorTaskListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get_serve_url(filter_type = KalturaNotImplemented, filter_input = KalturaNotImplemented, status = KalturaNotImplemented, due_date = KalturaNotImplemented) ⇒ string

Returns:

  • (string) 


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2116

def get_serve_url(filter_type=KalturaNotImplemented, filter_input=KalturaNotImplemented, status=KalturaNotImplemented, due_date=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filterType', filter_type)
	client.add_param(kparams, 'filterInput', filter_input)
	client.add_param(kparams, 'status', status)
	client.add_param(kparams, 'dueDate', due_date)
	client.queue_service_action_call('reach_entryvendortask', 'getServeUrl', 'string', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaEntryVendorTaskListResponse

List KalturaEntryVendorTask objects

Returns:



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2131

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('reach_entryvendortask', 'list', 'KalturaEntryVendorTaskListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#reject(id, reject_reason = KalturaNotImplemented) ⇒ KalturaEntryVendorTask

Reject entry vendor task for execution.

Returns:



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2144

def reject(id, reject_reason=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'rejectReason', reject_reason)
	client.queue_service_action_call('reach_entryvendortask', 'reject', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#serve(vendor_partner_id = KalturaNotImplemented, partner_id = KalturaNotImplemented, status = KalturaNotImplemented, due_date = KalturaNotImplemented) ⇒ file

Returns:

  • (file) 


2156
2157
2158
2159
2160
2161
2162
2163
2164
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2156

def serve(vendor_partner_id=KalturaNotImplemented, partner_id=KalturaNotImplemented, status=KalturaNotImplemented, due_date=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'vendorPartnerId', vendor_partner_id)
	client.add_param(kparams, 'partnerId', partner_id)
	client.add_param(kparams, 'status', status)
	client.add_param(kparams, 'dueDate', due_date)
	client.queue_service_action_call('reach_entryvendortask', 'serve', 'file', kparams)
	return client.get_serve_url()
end

#serve_csv(id) ⇒ string

Will serve a requested csv

Returns:

  • (string) 


2168
2169
2170
2171
2172
2173
2174
2175
2176
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2168

def serve_csv(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('reach_entryvendortask', 'serveCsv', 'string', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(id, entry_vendor_task) ⇒ KalturaEntryVendorTask

Update entry vendor task. Only the properties that were set will be updated.

Returns:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2180

def update(id, entry_vendor_task)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'entryVendorTask', entry_vendor_task)
	client.queue_service_action_call('reach_entryvendortask', 'update', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update_job(id, entry_vendor_task) ⇒ KalturaEntryVendorTask

Update entry vendor task. Only the properties that were set will be updated.

Returns:



2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2193

def update_job(id, entry_vendor_task)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'entryVendorTask', entry_vendor_task)
	client.queue_service_action_call('reach_entryvendortask', 'updateJob', 'KalturaEntryVendorTask', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end