Class: MxPlatformRuby::GoalsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/api/goals_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GoalsApi

Returns a new instance of GoalsApi.



19
20
21
 
# File 'lib/mx-platform-ruby/api/goals_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/mx-platform-ruby/api/goals_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#users_user_guid_goals_get(user_guid, opts = {}) ⇒ GoalsResponseBody

List goals List all goals a user can set.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.

  • :records_per_age (String) —

    The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.

Returns:



29
30
31
32
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 29

def users_user_guid_goals_get(user_guid, opts = {})
  data, _status_code, _headers = users_user_guid_goals_get_with_http_info(user_guid, opts)
  data
end

#users_user_guid_goals_get_with_http_info(user_guid, opts = {}) ⇒ Array<(GoalsResponseBody, Integer, Hash)>

List goals List all goals a user can set.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.

  • :records_per_age (String) —

    The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.

Returns:

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

    GoalsResponseBody data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 41

def users_user_guid_goals_get_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_get ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_get"
  end
  # resource path
  local_var_path = '/users/{user_guid}/goals'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"GoalsApi.users_user_guid_goals_get",
    :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: GoalsApi#users_user_guid_goals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_goals_goal_guid_delete(goal_guid, user_guid, opts = {}) ⇒ nil

Delete a goal Delete a goal.

Parameters:

  • goal_guid (String) —

    The unique identifier for a goal. Defined by MX.

  • user_guid (String) —

    The unique identifier for a user.

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

    the optional parameters

Returns:

  • (nil) 


97
98
99
100
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 97

def users_user_guid_goals_goal_guid_delete(goal_guid, user_guid, opts = {})
  users_user_guid_goals_goal_guid_delete_with_http_info(goal_guid, user_guid, opts)
  nil
end

#users_user_guid_goals_goal_guid_delete_with_http_info(goal_guid, user_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a goal Delete a goal.

Parameters:

  • goal_guid (String) —

    The unique identifier for a goal. Defined by MX.

  • user_guid (String) —

    The unique identifier for a user.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 108

def users_user_guid_goals_goal_guid_delete_with_http_info(goal_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_goal_guid_delete ...'
  end
  # verify the required parameter 'goal_guid' is set
  if @api_client.config.client_side_validation && goal_guid.nil?
    fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_delete"
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_delete"
  end
  # resource path
  local_var_path = '/users/{user_guid}/goals/{goal_guid}'.sub('{' + 'goal_guid' + '}', CGI.escape(goal_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"GoalsApi.users_user_guid_goals_goal_guid_delete",
    :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: GoalsApi#users_user_guid_goals_goal_guid_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_goals_goal_guid_get(goal_guid, user_guid, opts = {}) ⇒ GoalResponseBody

Read a goal Read a specific goal.

Parameters:

  • goal_guid (String) —

    The unique identifier for a goal. Defined by MX.

  • user_guid (String) —

    The unique identifier for a user.

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 164

def users_user_guid_goals_goal_guid_get(goal_guid, user_guid, opts = {})
  data, _status_code, _headers = users_user_guid_goals_goal_guid_get_with_http_info(goal_guid, user_guid, opts)
  data
end

#users_user_guid_goals_goal_guid_get_with_http_info(goal_guid, user_guid, opts = {}) ⇒ Array<(GoalResponseBody, Integer, Hash)>

Read a goal Read a specific goal.

Parameters:

  • goal_guid (String) —

    The unique identifier for a goal. Defined by MX.

  • user_guid (String) —

    The unique identifier for a user.

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

    the optional parameters

Returns:

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

    GoalResponseBody data, response status code and response headers



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 175

def users_user_guid_goals_goal_guid_get_with_http_info(goal_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_goal_guid_get ...'
  end
  # verify the required parameter 'goal_guid' is set
  if @api_client.config.client_side_validation && goal_guid.nil?
    fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_get"
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_get"
  end
  # resource path
  local_var_path = '/users/{user_guid}/goals/{goal_guid}'.sub('{' + 'goal_guid' + '}', CGI.escape(goal_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"GoalsApi.users_user_guid_goals_goal_guid_get",
    :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: GoalsApi#users_user_guid_goals_goal_guid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_goals_goal_guid_put(goal_guid, user_guid, update_goal_request_body, opts = {}) ⇒ GoalResponseBody

Update a goal This endpoint updates a specific goal.

Parameters:

  • goal_guid (String) —

    The unique identifier for a goal. Defined by MX.

  • user_guid (String) —

    The unique identifier for a user.

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

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 234

def users_user_guid_goals_goal_guid_put(goal_guid, user_guid, update_goal_request_body, opts = {})
  data, _status_code, _headers = users_user_guid_goals_goal_guid_put_with_http_info(goal_guid, user_guid, update_goal_request_body, opts)
  data
end

#users_user_guid_goals_goal_guid_put_with_http_info(goal_guid, user_guid, update_goal_request_body, opts = {}) ⇒ Array<(GoalResponseBody, Integer, Hash)>

Update a goal This endpoint updates a specific goal.

Parameters:

  • goal_guid (String) —

    The unique identifier for a goal. Defined by MX.

  • user_guid (String) —

    The unique identifier for a user.

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

    the optional parameters

Returns:

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

    GoalResponseBody data, response status code and response headers



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 246

def users_user_guid_goals_goal_guid_put_with_http_info(goal_guid, user_guid, update_goal_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_goal_guid_put ...'
  end
  # verify the required parameter 'goal_guid' is set
  if @api_client.config.client_side_validation && goal_guid.nil?
    fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_put"
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_put"
  end
  # verify the required parameter 'update_goal_request_body' is set
  if @api_client.config.client_side_validation && update_goal_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'update_goal_request_body' when calling GoalsApi.users_user_guid_goals_goal_guid_put"
  end
  # resource path
  local_var_path = '/users/{user_guid}/goals/{goal_guid}'.sub('{' + 'goal_guid' + '}', CGI.escape(goal_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.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']) unless header_params['Accept']
  # 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(update_goal_request_body)

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

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

  new_options = opts.merge(
    :operation => :"GoalsApi.users_user_guid_goals_goal_guid_put",
    :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: GoalsApi#users_user_guid_goals_goal_guid_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_goals_post(user_guid, goal_request_body, opts = {}) ⇒ GoalResponseBody

Create a goal Create a goal. This endpoint accepts the optional ‘MX-Skip-Webhook` header and `skip_webhook` parameter.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

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

    the optional parameters

Returns:



313
314
315
316
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 313

def users_user_guid_goals_post(user_guid, goal_request_body, opts = {})
  data, _status_code, _headers = users_user_guid_goals_post_with_http_info(user_guid, goal_request_body, opts)
  data
end

#users_user_guid_goals_post_with_http_info(user_guid, goal_request_body, opts = {}) ⇒ Array<(GoalResponseBody, Integer, Hash)>

Create a goal Create a goal. This endpoint accepts the optional &#x60;MX-Skip-Webhook&#x60; header and &#x60;skip_webhook&#x60; parameter.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

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

    the optional parameters

Returns:

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

    GoalResponseBody data, response status code and response headers



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 324

def users_user_guid_goals_post_with_http_info(user_guid, goal_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_post ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_post"
  end
  # verify the required parameter 'goal_request_body' is set
  if @api_client.config.client_side_validation && goal_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'goal_request_body' when calling GoalsApi.users_user_guid_goals_post"
  end
  # resource path
  local_var_path = '/users/{user_guid}/goals'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.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']) unless header_params['Accept']
  # 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(goal_request_body)

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

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

  new_options = opts.merge(
    :operation => :"GoalsApi.users_user_guid_goals_post",
    :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: GoalsApi#users_user_guid_goals_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_goals_reposition_put(user_guid, reposition_request_body, opts = {}) ⇒ RepositionResponseBody

Reposition goals This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

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

    the optional parameters

Returns:



387
388
389
390
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 387

def users_user_guid_goals_reposition_put(user_guid, reposition_request_body, opts = {})
  data, _status_code, _headers = users_user_guid_goals_reposition_put_with_http_info(user_guid, reposition_request_body, opts)
  data
end

#users_user_guid_goals_reposition_put_with_http_info(user_guid, reposition_request_body, opts = {}) ⇒ Array<(RepositionResponseBody, Integer, Hash)>

Reposition goals This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

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

    the optional parameters

Returns:

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

    RepositionResponseBody data, response status code and response headers



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/mx-platform-ruby/api/goals_api.rb', line 398

def users_user_guid_goals_reposition_put_with_http_info(user_guid, reposition_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_reposition_put ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_reposition_put"
  end
  # verify the required parameter 'reposition_request_body' is set
  if @api_client.config.client_side_validation && reposition_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'reposition_request_body' when calling GoalsApi.users_user_guid_goals_reposition_put"
  end
  # resource path
  local_var_path = '/users/{user_guid}/goals/reposition'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.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']) unless header_params['Accept']
  # 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(reposition_request_body)

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

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

  new_options = opts.merge(
    :operation => :"GoalsApi.users_user_guid_goals_reposition_put",
    :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: GoalsApi#users_user_guid_goals_reposition_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end