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.



1817
1818
1819
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1817

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:



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1823

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:



1836
1837
1838
1839
1840
1841
1842
1843
1844
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1836

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:



1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1848

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) 


1860
1861
1862
1863
1864
1865
1866
1867
1868
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1860

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:



1872
1873
1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1872

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:



1884
1885
1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1884

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:



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1896

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) 


1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1908

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:



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1923

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:



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

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) 


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

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) 


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

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:



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

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:



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

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