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.



1983
1984
1985
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1983

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:



1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1989

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:



2002
2003
2004
2005
2006
2007
2008
2009
2010
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2002

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:



2014
2015
2016
2017
2018
2019
2020
2021
2022
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2014

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) 


2026
2027
2028
2029
2030
2031
2032
2033
2034
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2026

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:



2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2038

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:



2050
2051
2052
2053
2054
2055
2056
2057
2058
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2050

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:



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2062

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) 


2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2074

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:



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2089

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:



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

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) 


2114
2115
2116
2117
2118
2119
2120
2121
2122
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2114

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) 


2126
2127
2128
2129
2130
2131
2132
2133
2134
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2126

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:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2138

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:



2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2151

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