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.



1799
1800
1801
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1799

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:



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1805

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:



1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1818

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:



1830
1831
1832
1833
1834
1835
1836
1837
1838
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1830

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) 


1842
1843
1844
1845
1846
1847
1848
1849
1850
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1842

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:



1854
1855
1856
1857
1858
1859
1860
1861
1862
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1854

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:



1866
1867
1868
1869
1870
1871
1872
1873
1874
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1866

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:



1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1878

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) 


1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1890

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:



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1905

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:



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

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) 


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

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) 


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

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:



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

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:



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

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