Class: Athenian::AlignApi

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/api/align_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AlignApi

Returns a new instance of AlignApi.



16
17
18
 
# File 'lib/athenian/api/align_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/athenian/api/align_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_goal_template(opts = {}) ⇒ CreatedIdentifier

👤 Create a goal template.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



23
24
25
26
 
# File 'lib/athenian/api/align_api.rb', line 23

def create_goal_template(opts = {})
  data, _status_code, _headers = create_goal_template_with_http_info(opts)
  data
end

#create_goal_template_with_http_info(opts = {}) ⇒ Array<(CreatedIdentifier, Integer, Hash)>

👤 Create a goal template.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(CreatedIdentifier, Integer, Hash)>) —

    CreatedIdentifier data, response status code and response headers



32
33
34
35
36
37
38
39
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
76
77
78
79
 
# File 'lib/athenian/api/align_api.rb', line 32

def create_goal_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlignApi.create_goal_template ...'
  end
  # resource path
  local_var_path = '/goal_template/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreatedIdentifier'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AlignApi.create_goal_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlignApi#create_goal_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_goal_template(id, opts = {}) ⇒ Object

👤 Delete a goal template.

Parameters:

  • id (Integer) —

    Numeric identifier of the goal template.

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

    the optional parameters

Returns:

  • (Object) 


85
86
87
88
 
# File 'lib/athenian/api/align_api.rb', line 85

def delete_goal_template(id, opts = {})
  data, _status_code, _headers = delete_goal_template_with_http_info(id, opts)
  data
end

#delete_goal_template_with_http_info(id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

👤 Delete a goal template.

Parameters:

  • id (Integer) —

    Numeric identifier of the goal template.

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
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
 
# File 'lib/athenian/api/align_api.rb', line 94

def delete_goal_template_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlignApi.delete_goal_template ...'
  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 AlignApi.delete_goal_template"
  end
  # resource path
  local_var_path = '/goal_template/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AlignApi.delete_goal_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlignApi#delete_goal_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_goal_template(id, opts = {}) ⇒ GoalTemplate

Retrieve a goal template.

Parameters:

  • id (Integer) —

    Numeric identifier of the goal template.

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

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/athenian/api/align_api.rb', line 146

def get_goal_template(id, opts = {})
  data, _status_code, _headers = get_goal_template_with_http_info(id, opts)
  data
end

#get_goal_template_with_http_info(id, opts = {}) ⇒ Array<(GoalTemplate, Integer, Hash)>

Retrieve a goal template.

Parameters:

  • id (Integer) —

    Numeric identifier of the goal template.

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

    the optional parameters

Returns:

  • (Array<(GoalTemplate, Integer, Hash)>) —

    GoalTemplate data, response status code and response headers



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/athenian/api/align_api.rb', line 155

def get_goal_template_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlignApi.get_goal_template ...'
  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 AlignApi.get_goal_template"
  end
  # resource path
  local_var_path = '/goal_template/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GoalTemplate'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"AlignApi.get_goal_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlignApi#get_goal_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_goal_templates(id, opts = {}) ⇒ Array<GoalTemplate>

List the goal templates for the account.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Options Hash (opts):

  • :include_tlo (Boolean) —

    Include templates for TLOs goals, i.e. goals based on parameterized metrics. (default to false)

Returns:



208
209
210
211
 
# File 'lib/athenian/api/align_api.rb', line 208

def list_goal_templates(id, opts = {})
  data, _status_code, _headers = list_goal_templates_with_http_info(id, opts)
  data
end

#list_goal_templates_with_http_info(id, opts = {}) ⇒ Array<(Array<GoalTemplate>, Integer, Hash)>

List the goal templates for the account.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Options Hash (opts):

  • :include_tlo (Boolean) —

    Include templates for TLOs goals, i.e. goals based on parameterized metrics. (default to false)

Returns:

  • (Array<(Array<GoalTemplate>, Integer, Hash)>) —

    Array<GoalTemplate> data, response status code and response headers



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/athenian/api/align_api.rb', line 218

def list_goal_templates_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlignApi.list_goal_templates ...'
  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 AlignApi.list_goal_templates"
  end
  # resource path
  local_var_path = '/goal_templates/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_tlo'] = opts[:'include_tlo'] if !opts[:'include_tlo'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GoalTemplate>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"AlignApi.list_goal_templates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlignApi#list_goal_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_goal_template(id, opts = {}) ⇒ Object

👤 Update a goal template.

Parameters:

  • id (Integer) —

    Numeric identifier of the goal template.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


272
273
274
275
 
# File 'lib/athenian/api/align_api.rb', line 272

def update_goal_template(id, opts = {})
  data, _status_code, _headers = update_goal_template_with_http_info(id, opts)
  data
end

#update_goal_template_with_http_info(id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

👤 Update a goal template.

Parameters:

  • id (Integer) —

    Numeric identifier of the goal template.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/athenian/api/align_api.rb', line 282

def update_goal_template_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlignApi.update_goal_template ...'
  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 AlignApi.update_goal_template"
  end
  # resource path
  local_var_path = '/goal_template/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AlignApi.update_goal_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlignApi#update_goal_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end