Class: TripletexApi::ActivityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/activity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ActivityApi

Returns a new instance of ActivityApi.



19
20
21
 
# File 'lib/tripletex_api/api/activity_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_api/api/activity_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(id, opts = {}) ⇒ ResponseWrapperActivity

Find activity by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



29
30
31
32
 
# File 'lib/tripletex_api/api/activity_api.rb', line 29

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  return data
end

#get_for_time_sheet(project_id, opts = {}) ⇒ ListResponseActivity

Find applicable time sheet activities for an employee on a specific day.

Parameters:

  • project_id —

    Project ID

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :date (String) —

    yyyy-MM-dd. Defaults to today.

  • :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:



88
89
90
91
 
# File 'lib/tripletex_api/api/activity_api.rb', line 88

def get_for_time_sheet(project_id, opts = {})
  data, _status_code, _headers = get_for_time_sheet_with_http_info(project_id, opts)
  return data
end

#get_for_time_sheet_with_http_info(project_id, opts = {}) ⇒ Array<(ListResponseActivity, Fixnum, Hash)>

Find applicable time sheet activities for an employee on a specific day.

Parameters:

  • project_id —

    Project ID

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :date (String) —

    yyyy-MM-dd. Defaults to today.

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseActivity data, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/tripletex_api/api/activity_api.rb', line 104

def get_for_time_sheet_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ActivityApi.get_for_time_sheet ..."
  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 ActivityApi.get_for_time_sheet"
  end
  # resource path
  local_var_path = "/activity/>forTimeSheet"

  # query parameters
  query_params = {}
  query_params[:'projectId'] = project_id
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  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 => 'ListResponseActivity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivityApi#get_for_time_sheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperActivity, Fixnum, Hash)>

Find activity by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperActivity data, response status code and response headers



40
41
42
43
44
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
 
# File 'lib/tripletex_api/api/activity_api.rb', line 40

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ActivityApi.get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ActivityApi.get"
  end
  # resource path
  local_var_path = "/activity/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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 => 'ResponseWrapperActivity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivityApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseActivity

Find activities corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :name (String) —

    Containing

  • :number (String) —

    Equals

  • :description (String) —

    Containing

  • :is_project_activity (BOOLEAN) —

    Equals

  • :is_general (BOOLEAN) —

    Equals

  • :is_chargeable (BOOLEAN) —

    Equals

  • :is_task (BOOLEAN) —

    Equals

  • :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:



163
164
165
166
 
# File 'lib/tripletex_api/api/activity_api.rb', line 163

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

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

Find activities corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :name (String) —

    Containing

  • :number (String) —

    Equals

  • :description (String) —

    Containing

  • :is_project_activity (BOOLEAN) —

    Equals

  • :is_general (BOOLEAN) —

    Equals

  • :is_chargeable (BOOLEAN) —

    Equals

  • :is_task (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseActivity data, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/tripletex_api/api/activity_api.rb', line 184

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ActivityApi.search ..."
  end
  # resource path
  local_var_path = "/activity"

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
  query_params[:'isProjectActivity'] = opts[:'is_project_activity'] if !opts[:'is_project_activity'].nil?
  query_params[:'isGeneral'] = opts[:'is_general'] if !opts[:'is_general'].nil?
  query_params[:'isChargeable'] = opts[:'is_chargeable'] if !opts[:'is_chargeable'].nil?
  query_params[:'isTask'] = opts[:'is_task'] if !opts[:'is_task'].nil?
  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 => 'ListResponseActivity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActivityApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end