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.



1907
1908
1909
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1907

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:



1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1913

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:



1926
1927
1928
1929
1930
1931
1932
1933
1934
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1926

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:



1938
1939
1940
1941
1942
1943
1944
1945
1946
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1938

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) 


1950
1951
1952
1953
1954
1955
1956
1957
1958
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1950

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:



1962
1963
1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1962

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:



1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1974

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:



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1986

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) 


1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1998

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:



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

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:



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

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) 


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

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) 


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

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:



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

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:



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

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