Class: TripletexRubyClient::ProjecttaskApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/projecttask_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProjecttaskApi

Returns a new instance of ProjecttaskApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/projecttask_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tripletex_ruby_client/api/projecttask_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#search(project_id, opts = {}) ⇒ ListResponseTask

Find all tasks for project.

Parameters:

  • project_id —

    Equals

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



31
32
33
34
 
# File 'lib/tripletex_ruby_client/api/projecttask_api.rb', line 31

def search(project_id, opts = {})
  data, _status_code, _headers = search_with_http_info(project_id, opts)
  data
end

#search_with_http_info(project_id, opts = {}) ⇒ Array<(ListResponseTask, Fixnum, Hash)>

Find all tasks for project.

Parameters:

  • project_id —

    Equals

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

  • (Array<(ListResponseTask, Fixnum, Hash)>) —

    ListResponseTask data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/tripletex_ruby_client/api/projecttask_api.rb', line 45

def search_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjecttaskApi.search ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjecttaskApi.search"
  end
  # resource path
  local_var_path = '/project/task'

  # query parameters
  query_params = {}
  query_params[:'projectId'] = project_id
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseTask')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjecttaskApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end