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.



1912
1913
1914
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1912

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:



1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1918

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:



1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1931

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:



1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1943

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) 


1955
1956
1957
1958
1959
1960
1961
1962
1963
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1955

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:



1967
1968
1969
1970
1971
1972
1973
1974
1975
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1967

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:



1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1979

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:



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

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) 


2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2003

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:



2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 2018

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:



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

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) 


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

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) 


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

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:



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

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:



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

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