Class: Shortcut::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/shortcut_client_ruby/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/shortcut_client_ruby/api/default_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/shortcut_client_ruby/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_category(create_category, opts = {}) ⇒ Category

Create Category Create Category allows you to create a new Category in Shortcut.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 27

def create_category(create_category, opts = {})
  data, _status_code, _headers = create_category_with_http_info(create_category, opts)
  data
end

#create_category_with_http_info(create_category, opts = {}) ⇒ Array<(Category, Integer, Hash)>

Create Category Create Category allows you to create a new Category in Shortcut.

Parameters:

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

    the optional parameters

Returns:

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

    Category data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 37

def create_category_with_http_info(create_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_category ...'
  end
  # verify the required parameter 'create_category' is set
  if @api_client.config.client_side_validation && create_category.nil?
    fail ArgumentError, "Missing the required parameter 'create_category' when calling DefaultApi.create_category"
  end
  # resource path
  local_var_path = '/api/v3/categories'

  # 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(create_category)

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

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

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

#create_entity_template(create_entity_template, opts = {}) ⇒ EntityTemplate

Create Entity Template Create a new entity template for your organization.

Parameters:

  • create_entity_template (CreateEntityTemplate) —

    Request paramaters for creating an entirely new entity template.

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 95

def create_entity_template(create_entity_template, opts = {})
  data, _status_code, _headers = create_entity_template_with_http_info(create_entity_template, opts)
  data
end

#create_entity_template_with_http_info(create_entity_template, opts = {}) ⇒ Array<(EntityTemplate, Integer, Hash)>

Create Entity Template Create a new entity template for your organization.

Parameters:

  • create_entity_template (CreateEntityTemplate) —

    Request paramaters for creating an entirely new entity template.

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

    the optional parameters

Returns:

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

    EntityTemplate data, response status code and response headers



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
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 105

def create_entity_template_with_http_info(create_entity_template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_entity_template ...'
  end
  # verify the required parameter 'create_entity_template' is set
  if @api_client.config.client_side_validation && create_entity_template.nil?
    fail ArgumentError, "Missing the required parameter 'create_entity_template' when calling DefaultApi.create_entity_template"
  end
  # resource path
  local_var_path = '/api/v3/entity-templates'

  # 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(create_entity_template)

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

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

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

#create_epic(create_epic, opts = {}) ⇒ Epic

Create Epic Create Epic allows you to create a new Epic in Shortcut.

Parameters:

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 163

def create_epic(create_epic, opts = {})
  data, _status_code, _headers = create_epic_with_http_info(create_epic, opts)
  data
end

#create_epic_comment(epic_public_id, create_epic_comment, opts = {}) ⇒ ThreadedComment

Create Epic Comment This endpoint allows you to create a threaded Comment on an Epic.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

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

    the optional parameters

Returns:



232
233
234
235
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 232

def create_epic_comment(epic_public_id, create_epic_comment, opts = {})
  data, _status_code, _headers = create_epic_comment_with_http_info(epic_public_id, create_epic_comment, opts)
  data
end

#create_epic_comment_comment(epic_public_id, comment_public_id, create_comment_comment, opts = {}) ⇒ ThreadedComment

Create Epic Comment Comment This endpoint allows you to create a nested Comment reply to an existing Epic Comment.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the parent Epic Comment.

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

    the optional parameters

Returns:



307
308
309
310
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 307

def create_epic_comment_comment(epic_public_id, comment_public_id, create_comment_comment, opts = {})
  data, _status_code, _headers = create_epic_comment_comment_with_http_info(epic_public_id, comment_public_id, create_comment_comment, opts)
  data
end

#create_epic_comment_comment_with_http_info(epic_public_id, comment_public_id, create_comment_comment, opts = {}) ⇒ Array<(ThreadedComment, Integer, Hash)>

Create Epic Comment Comment This endpoint allows you to create a nested Comment reply to an existing Epic Comment.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the parent Epic Comment.

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

    the optional parameters

Returns:

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

    ThreadedComment data, response status code and response headers



319
320
321
322
323
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 319

def create_epic_comment_comment_with_http_info(epic_public_id, comment_public_id, create_comment_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_epic_comment_comment ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.create_epic_comment_comment"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.create_epic_comment_comment"
  end
  # verify the required parameter 'create_comment_comment' is set
  if @api_client.config.client_side_validation && create_comment_comment.nil?
    fail ArgumentError, "Missing the required parameter 'create_comment_comment' when calling DefaultApi.create_epic_comment_comment"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/comments/{comment-public-id}'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_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(create_comment_comment)

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

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

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

#create_epic_comment_with_http_info(epic_public_id, create_epic_comment, opts = {}) ⇒ Array<(ThreadedComment, Integer, Hash)>

Create Epic Comment This endpoint allows you to create a threaded Comment on an Epic.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

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

    the optional parameters

Returns:

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

    ThreadedComment data, response status code and response headers



243
244
245
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 243

def create_epic_comment_with_http_info(epic_public_id, create_epic_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_epic_comment ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.create_epic_comment"
  end
  # verify the required parameter 'create_epic_comment' is set
  if @api_client.config.client_side_validation && create_epic_comment.nil?
    fail ArgumentError, "Missing the required parameter 'create_epic_comment' when calling DefaultApi.create_epic_comment"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/comments'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_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(create_epic_comment)

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

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

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

#create_epic_with_http_info(create_epic, opts = {}) ⇒ Array<(Epic, Integer, Hash)>

Create Epic Create Epic allows you to create a new Epic in Shortcut.

Parameters:

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

    the optional parameters

Returns:

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

    Epic data, response status code and response headers



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

def create_epic_with_http_info(create_epic, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_epic ...'
  end
  # verify the required parameter 'create_epic' is set
  if @api_client.config.client_side_validation && create_epic.nil?
    fail ArgumentError, "Missing the required parameter 'create_epic' when calling DefaultApi.create_epic"
  end
  # resource path
  local_var_path = '/api/v3/epics'

  # 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(create_epic)

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

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

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

#create_group(create_group, opts = {}) ⇒ Group

Create Group

Parameters:

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

    the optional parameters

Returns:



384
385
386
387
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 384

def create_group(create_group, opts = {})
  data, _status_code, _headers = create_group_with_http_info(create_group, opts)
  data
end

#create_group_with_http_info(create_group, opts = {}) ⇒ Array<(Group, Integer, Hash)>

Create Group

Parameters:

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

    the optional parameters

Returns:

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

    Group data, response status code and response headers



393
394
395
396
397
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 393

def create_group_with_http_info(create_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_group ...'
  end
  # verify the required parameter 'create_group' is set
  if @api_client.config.client_side_validation && create_group.nil?
    fail ArgumentError, "Missing the required parameter 'create_group' when calling DefaultApi.create_group"
  end
  # resource path
  local_var_path = '/api/v3/groups'

  # 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(create_group)

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

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

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

#create_iteration(create_iteration, opts = {}) ⇒ Iteration

Create Iteration

Parameters:

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

    the optional parameters

Returns:



450
451
452
453
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 450

def create_iteration(create_iteration, opts = {})
  data, _status_code, _headers = create_iteration_with_http_info(create_iteration, opts)
  data
end

#create_iteration_with_http_info(create_iteration, opts = {}) ⇒ Array<(Iteration, Integer, Hash)>

Create Iteration

Parameters:

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

    the optional parameters

Returns:

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

    Iteration data, response status code and response headers



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 459

def create_iteration_with_http_info(create_iteration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_iteration ...'
  end
  # verify the required parameter 'create_iteration' is set
  if @api_client.config.client_side_validation && create_iteration.nil?
    fail ArgumentError, "Missing the required parameter 'create_iteration' when calling DefaultApi.create_iteration"
  end
  # resource path
  local_var_path = '/api/v3/iterations'

  # 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(create_iteration)

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

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

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

#create_label(create_label_params, opts = {}) ⇒ Label

Create Label Create Label allows you to create a new Label in Shortcut.

Parameters:

  • create_label_params (CreateLabelParams) —

    Request parameters for creating a Label on a Shortcut Story.

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

    the optional parameters

Returns:



517
518
519
520
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 517

def create_label(create_label_params, opts = {})
  data, _status_code, _headers = create_label_with_http_info(create_label_params, opts)
  data
end

#create_label_with_http_info(create_label_params, opts = {}) ⇒ Array<(Label, Integer, Hash)>

Create Label Create Label allows you to create a new Label in Shortcut.

Parameters:

  • create_label_params (CreateLabelParams) —

    Request parameters for creating a Label on a Shortcut Story.

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

    the optional parameters

Returns:

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

    Label data, response status code and response headers



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 527

def create_label_with_http_info(create_label_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_label ...'
  end
  # verify the required parameter 'create_label_params' is set
  if @api_client.config.client_side_validation && create_label_params.nil?
    fail ArgumentError, "Missing the required parameter 'create_label_params' when calling DefaultApi.create_label"
  end
  # resource path
  local_var_path = '/api/v3/labels'

  # 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(create_label_params)

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

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

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

#create_linked_file(create_linked_file, opts = {}) ⇒ LinkedFile

Create Linked File Create Linked File allows you to create a new Linked File in Shortcut.

Parameters:

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

    the optional parameters

Returns:



585
586
587
588
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 585

def create_linked_file(create_linked_file, opts = {})
  data, _status_code, _headers = create_linked_file_with_http_info(create_linked_file, opts)
  data
end

#create_linked_file_with_http_info(create_linked_file, opts = {}) ⇒ Array<(LinkedFile, Integer, Hash)>

Create Linked File Create Linked File allows you to create a new Linked File in Shortcut.

Parameters:

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

    the optional parameters

Returns:

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

    LinkedFile data, response status code and response headers



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 595

def create_linked_file_with_http_info(create_linked_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_linked_file ...'
  end
  # verify the required parameter 'create_linked_file' is set
  if @api_client.config.client_side_validation && create_linked_file.nil?
    fail ArgumentError, "Missing the required parameter 'create_linked_file' when calling DefaultApi.create_linked_file"
  end
  # resource path
  local_var_path = '/api/v3/linked-files'

  # 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(create_linked_file)

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

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

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

#create_milestone(create_milestone, opts = {}) ⇒ Milestone

Create Milestone Create Milestone allows you to create a new Milestone in Shortcut.

Parameters:

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

    the optional parameters

Returns:



653
654
655
656
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 653

def create_milestone(create_milestone, opts = {})
  data, _status_code, _headers = create_milestone_with_http_info(create_milestone, opts)
  data
end

#create_milestone_with_http_info(create_milestone, opts = {}) ⇒ Array<(Milestone, Integer, Hash)>

Create Milestone Create Milestone allows you to create a new Milestone in Shortcut.

Parameters:

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

    the optional parameters

Returns:

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

    Milestone data, response status code and response headers



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 663

def create_milestone_with_http_info(create_milestone, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_milestone ...'
  end
  # verify the required parameter 'create_milestone' is set
  if @api_client.config.client_side_validation && create_milestone.nil?
    fail ArgumentError, "Missing the required parameter 'create_milestone' when calling DefaultApi.create_milestone"
  end
  # resource path
  local_var_path = '/api/v3/milestones'

  # 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(create_milestone)

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

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

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

#create_multiple_stories(create_stories, opts = {}) ⇒ Array<StorySlim>

Create Multiple Stories Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](shortcut.com/api/#create-story).

Parameters:

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

    the optional parameters

Returns:



721
722
723
724
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 721

def create_multiple_stories(create_stories, opts = {})
  data, _status_code, _headers = create_multiple_stories_with_http_info(create_stories, opts)
  data
end

#create_multiple_stories_with_http_info(create_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

Create Multiple Stories Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](shortcut.com/api/#create-story).

Parameters:

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

    the optional parameters

Returns:

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

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



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 731

def create_multiple_stories_with_http_info(create_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_multiple_stories ...'
  end
  # verify the required parameter 'create_stories' is set
  if @api_client.config.client_side_validation && create_stories.nil?
    fail ArgumentError, "Missing the required parameter 'create_stories' when calling DefaultApi.create_multiple_stories"
  end
  # resource path
  local_var_path = '/api/v3/stories/bulk'

  # 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(create_stories)

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

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

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

#create_project(create_project, opts = {}) ⇒ Project

Create Project Create Project is used to create a new Shortcut Project.

Parameters:

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

    the optional parameters

Returns:



789
790
791
792
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 789

def create_project(create_project, opts = {})
  data, _status_code, _headers = create_project_with_http_info(create_project, opts)
  data
end

#create_project_with_http_info(create_project, opts = {}) ⇒ Array<(Project, Integer, Hash)>

Create Project Create Project is used to create a new Shortcut Project.

Parameters:

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

    the optional parameters

Returns:

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

    Project data, response status code and response headers



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 799

def create_project_with_http_info(create_project, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_project ...'
  end
  # verify the required parameter 'create_project' is set
  if @api_client.config.client_side_validation && create_project.nil?
    fail ArgumentError, "Missing the required parameter 'create_project' when calling DefaultApi.create_project"
  end
  # resource path
  local_var_path = '/api/v3/projects'

  # 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(create_project)

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

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

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

#create_story(create_story_params, opts = {}) ⇒ Story

Create Story Create Story is used to add a new story to your Shortcut.

Parameters:

  • create_story_params (CreateStoryParams) —

    Request parameters for creating a story.

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

    the optional parameters

Returns:



857
858
859
860
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 857

def create_story(create_story_params, opts = {})
  data, _status_code, _headers = create_story_with_http_info(create_story_params, opts)
  data
end

#create_story_comment(story_public_id, create_story_comment, opts = {}) ⇒ StoryComment

Create Story Comment Create Comment allows you to create a Comment on any Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

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

    the optional parameters

Returns:



926
927
928
929
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 926

def create_story_comment(story_public_id, create_story_comment, opts = {})
  data, _status_code, _headers = create_story_comment_with_http_info(story_public_id, create_story_comment, opts)
  data
end

#create_story_comment_with_http_info(story_public_id, create_story_comment, opts = {}) ⇒ Array<(StoryComment, Integer, Hash)>

Create Story Comment Create Comment allows you to create a Comment on any Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

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

    the optional parameters

Returns:

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

    StoryComment data, response status code and response headers



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 937

def create_story_comment_with_http_info(story_public_id, create_story_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_story_comment ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.create_story_comment"
  end
  # verify the required parameter 'create_story_comment' is set
  if @api_client.config.client_side_validation && create_story_comment.nil?
    fail ArgumentError, "Missing the required parameter 'create_story_comment' when calling DefaultApi.create_story_comment"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/comments'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_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(create_story_comment)

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

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

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

#create_story_link(create_story_link, opts = {}) ⇒ StoryLink

Create Story Link Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence: subject -> verb -> object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story "blocks", "duplicates", or "relates to" the object story. Examples: - "story 5 blocks story 6” – story 6 is now "blocked" until story 5 is moved to a Done workflow state. - "story 2 duplicates story 1” – Story 2 represents the same body of work as Story 1 (and should probably be archived). - "story 7 relates to story 3”

Parameters:

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

    the optional parameters

Returns:



999
1000
1001
1002
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 999

def create_story_link(create_story_link, opts = {})
  data, _status_code, _headers = create_story_link_with_http_info(create_story_link, opts)
  data
end

#create_story_link_with_http_info(create_story_link, opts = {}) ⇒ Array<(StoryLink, Integer, Hash)>

Create Story Link Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence: subject -&gt; verb -&gt; object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story &quot;blocks&quot;, &quot;duplicates&quot;, or &quot;relates to&quot; the object story. Examples: - &quot;story 5 blocks story 6” – story 6 is now &quot;blocked&quot; until story 5 is moved to a Done workflow state. - &quot;story 2 duplicates story 1” – Story 2 represents the same body of work as Story 1 (and should probably be archived). - &quot;story 7 relates to story 3”

Parameters:

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

    the optional parameters

Returns:

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

    StoryLink data, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1009

def create_story_link_with_http_info(create_story_link, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_story_link ...'
  end
  # verify the required parameter 'create_story_link' is set
  if @api_client.config.client_side_validation && create_story_link.nil?
    fail ArgumentError, "Missing the required parameter 'create_story_link' when calling DefaultApi.create_story_link"
  end
  # resource path
  local_var_path = '/api/v3/story-links'

  # 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(create_story_link)

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

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

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

#create_story_reaction(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {}) ⇒ Array<StoryReaction>

Create Story Reaction Create a reaction to a story comment.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:



1069
1070
1071
1072
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1069

def create_story_reaction(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {})
  data, _status_code, _headers = create_story_reaction_with_http_info(story_public_id, comment_public_id, create_or_delete_story_reaction, opts)
  data
end

#create_story_reaction_with_http_info(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {}) ⇒ Array<(Array<StoryReaction>, Integer, Hash)>

Create Story Reaction Create a reaction to a story comment.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

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



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1081

def create_story_reaction_with_http_info(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_story_reaction ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.create_story_reaction"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.create_story_reaction"
  end
  # verify the required parameter 'create_or_delete_story_reaction' is set
  if @api_client.config.client_side_validation && create_or_delete_story_reaction.nil?
    fail ArgumentError, "Missing the required parameter 'create_or_delete_story_reaction' when calling DefaultApi.create_story_reaction"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_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(create_or_delete_story_reaction)

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

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

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

#create_story_with_http_info(create_story_params, opts = {}) ⇒ Array<(Story, Integer, Hash)>

Create Story Create Story is used to add a new story to your Shortcut.

Parameters:

  • create_story_params (CreateStoryParams) —

    Request parameters for creating a story.

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

    the optional parameters

Returns:

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

    Story data, response status code and response headers



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 867

def create_story_with_http_info(create_story_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_story ...'
  end
  # verify the required parameter 'create_story_params' is set
  if @api_client.config.client_side_validation && create_story_params.nil?
    fail ArgumentError, "Missing the required parameter 'create_story_params' when calling DefaultApi.create_story"
  end
  # resource path
  local_var_path = '/api/v3/stories'

  # 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(create_story_params)

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

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

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

#create_task(story_public_id, create_task, opts = {}) ⇒ Task

Create Task Create Task is used to create a new task in a Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Task will be in.

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

    the optional parameters

Returns:



1148
1149
1150
1151
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1148

def create_task(story_public_id, create_task, opts = {})
  data, _status_code, _headers = create_task_with_http_info(story_public_id, create_task, opts)
  data
end

#create_task_with_http_info(story_public_id, create_task, opts = {}) ⇒ Array<(Task, Integer, Hash)>

Create Task Create Task is used to create a new task in a Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Task will be in.

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

    the optional parameters

Returns:

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

    Task data, response status code and response headers



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1159

def create_task_with_http_info(story_public_id, create_task, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_task ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.create_task"
  end
  # verify the required parameter 'create_task' is set
  if @api_client.config.client_side_validation && create_task.nil?
    fail ArgumentError, "Missing the required parameter 'create_task' when calling DefaultApi.create_task"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/tasks'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_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(create_task)

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

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

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

#delete_category(category_public_id, opts = {}) ⇒ nil

Delete Category Delete Category can be used to delete any Category.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category.

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

    the optional parameters

Returns:

  • (nil) 


1221
1222
1223
1224
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1221

def delete_category(category_public_id, opts = {})
  delete_category_with_http_info(category_public_id, opts)
  nil
end

#delete_category_with_http_info(category_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Category Delete Category can be used to delete any Category.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1231

def delete_category_with_http_info(category_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_category ...'
  end
  # verify the required parameter 'category_public_id' is set
  if @api_client.config.client_side_validation && category_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_public_id' when calling DefaultApi.delete_category"
  end
  # resource path
  local_var_path = '/api/v3/categories/{category-public-id}'.sub('{' + 'category-public-id' + '}', CGI.escape(category_public_id.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] || ['api_token']

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

#delete_entity_template(entity_template_public_id, opts = {}) ⇒ nil

Delete Entity Template

Parameters:

  • entity_template_public_id (String) —

    The unique ID of the entity template.

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

    the optional parameters

Returns:

  • (nil) 


1281
1282
1283
1284
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1281

def delete_entity_template(entity_template_public_id, opts = {})
  delete_entity_template_with_http_info(entity_template_public_id, opts)
  nil
end

#delete_entity_template_with_http_info(entity_template_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Entity Template

Parameters:

  • entity_template_public_id (String) —

    The unique ID of the entity template.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1290

def delete_entity_template_with_http_info(entity_template_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_entity_template ...'
  end
  # verify the required parameter 'entity_template_public_id' is set
  if @api_client.config.client_side_validation && entity_template_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_template_public_id' when calling DefaultApi.delete_entity_template"
  end
  # resource path
  local_var_path = '/api/v3/entity-templates/{entity-template-public-id}'.sub('{' + 'entity-template-public-id' + '}', CGI.escape(entity_template_public_id.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] || ['api_token']

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

#delete_epic(epic_public_id, opts = {}) ⇒ nil

Delete Epic Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

  • (nil) 


1341
1342
1343
1344
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1341

def delete_epic(epic_public_id, opts = {})
  delete_epic_with_http_info(epic_public_id, opts)
  nil
end

#delete_epic_comment(epic_public_id, comment_public_id, opts = {}) ⇒ nil

Delete Epic Comment This endpoint allows you to delete a Comment from an Epic.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

  • (nil) 


1403
1404
1405
1406
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1403

def delete_epic_comment(epic_public_id, comment_public_id, opts = {})
  delete_epic_comment_with_http_info(epic_public_id, comment_public_id, opts)
  nil
end

#delete_epic_comment_with_http_info(epic_public_id, comment_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Epic Comment This endpoint allows you to delete a Comment from an Epic.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1414

def delete_epic_comment_with_http_info(epic_public_id, comment_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_epic_comment ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.delete_epic_comment"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.delete_epic_comment"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/comments/{comment-public-id}'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_id.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] || ['api_token']

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

#delete_epic_with_http_info(epic_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Epic Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1351

def delete_epic_with_http_info(epic_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_epic ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.delete_epic"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_id.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] || ['api_token']

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

#delete_file(file_public_id, opts = {}) ⇒ nil

Delete File Delete File deletes a previously uploaded file.

Parameters:

  • file_public_id (Integer) —

    The File’s unique ID.

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

    the optional parameters

Returns:

  • (nil) 


1469
1470
1471
1472
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1469

def delete_file(file_public_id, opts = {})
  delete_file_with_http_info(file_public_id, opts)
  nil
end

#delete_file_with_http_info(file_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete File Delete File deletes a previously uploaded file.

Parameters:

  • file_public_id (Integer) —

    The File’s unique ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1479

def delete_file_with_http_info(file_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_file ...'
  end
  # verify the required parameter 'file_public_id' is set
  if @api_client.config.client_side_validation && file_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_public_id' when calling DefaultApi.delete_file"
  end
  # resource path
  local_var_path = '/api/v3/files/{file-public-id}'.sub('{' + 'file-public-id' + '}', CGI.escape(file_public_id.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] || ['api_token']

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

#delete_iteration(iteration_public_id, opts = {}) ⇒ nil

Delete Iteration

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:

  • (nil) 


1529
1530
1531
1532
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1529

def delete_iteration(iteration_public_id, opts = {})
  delete_iteration_with_http_info(iteration_public_id, opts)
  nil
end

#delete_iteration_with_http_info(iteration_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Iteration

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1538

def delete_iteration_with_http_info(iteration_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_iteration ...'
  end
  # verify the required parameter 'iteration_public_id' is set
  if @api_client.config.client_side_validation && iteration_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'iteration_public_id' when calling DefaultApi.delete_iteration"
  end
  # resource path
  local_var_path = '/api/v3/iterations/{iteration-public-id}'.sub('{' + 'iteration-public-id' + '}', CGI.escape(iteration_public_id.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] || ['api_token']

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

#delete_label(label_public_id, opts = {}) ⇒ nil

Delete Label Delete Label can be used to delete any Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:

  • (nil) 


1589
1590
1591
1592
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1589

def delete_label(label_public_id, opts = {})
  delete_label_with_http_info(label_public_id, opts)
  nil
end

#delete_label_with_http_info(label_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Label Delete Label can be used to delete any Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1599

def delete_label_with_http_info(label_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_label ...'
  end
  # verify the required parameter 'label_public_id' is set
  if @api_client.config.client_side_validation && label_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_public_id' when calling DefaultApi.delete_label"
  end
  # resource path
  local_var_path = '/api/v3/labels/{label-public-id}'.sub('{' + 'label-public-id' + '}', CGI.escape(label_public_id.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] || ['api_token']

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

#delete_linked_file(linked_file_public_id, opts = {}) ⇒ nil

Delete Linked File Delete Linked File can be used to delete any previously attached Linked-File.

Parameters:

  • linked_file_public_id (Integer) —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:

  • (nil) 


1650
1651
1652
1653
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1650

def delete_linked_file(linked_file_public_id, opts = {})
  delete_linked_file_with_http_info(linked_file_public_id, opts)
  nil
end

#delete_linked_file_with_http_info(linked_file_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Linked File Delete Linked File can be used to delete any previously attached Linked-File.

Parameters:

  • linked_file_public_id (Integer) —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1660

def delete_linked_file_with_http_info(linked_file_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_linked_file ...'
  end
  # verify the required parameter 'linked_file_public_id' is set
  if @api_client.config.client_side_validation && linked_file_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'linked_file_public_id' when calling DefaultApi.delete_linked_file"
  end
  # resource path
  local_var_path = '/api/v3/linked-files/{linked-file-public-id}'.sub('{' + 'linked-file-public-id' + '}', CGI.escape(linked_file_public_id.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] || ['api_token']

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

#delete_milestone(milestone_public_id, opts = {}) ⇒ nil

Delete Milestone Delete Milestone can be used to delete any Milestone.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:

  • (nil) 


1711
1712
1713
1714
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1711

def delete_milestone(milestone_public_id, opts = {})
  delete_milestone_with_http_info(milestone_public_id, opts)
  nil
end

#delete_milestone_with_http_info(milestone_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Milestone Delete Milestone can be used to delete any Milestone.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1721

def delete_milestone_with_http_info(milestone_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_milestone ...'
  end
  # verify the required parameter 'milestone_public_id' is set
  if @api_client.config.client_side_validation && milestone_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'milestone_public_id' when calling DefaultApi.delete_milestone"
  end
  # resource path
  local_var_path = '/api/v3/milestones/{milestone-public-id}'.sub('{' + 'milestone-public-id' + '}', CGI.escape(milestone_public_id.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] || ['api_token']

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

#delete_multiple_stories(delete_stories, opts = {}) ⇒ nil

Delete Multiple Stories Delete Multiple Stories allows you to delete multiple archived stories at once.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1772
1773
1774
1775
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1772

def delete_multiple_stories(delete_stories, opts = {})
  delete_multiple_stories_with_http_info(delete_stories, opts)
  nil
end

#delete_multiple_stories_with_http_info(delete_stories, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Multiple Stories Delete Multiple Stories allows you to delete multiple archived stories at once.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1782

def delete_multiple_stories_with_http_info(delete_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_multiple_stories ...'
  end
  # verify the required parameter 'delete_stories' is set
  if @api_client.config.client_side_validation && delete_stories.nil?
    fail ArgumentError, "Missing the required parameter 'delete_stories' when calling DefaultApi.delete_multiple_stories"
  end
  # resource path
  local_var_path = '/api/v3/stories/bulk'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(delete_stories)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_project(project_public_id, opts = {}) ⇒ nil

Delete Project Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:

  • (nil) 


1838
1839
1840
1841
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1838

def delete_project(project_public_id, opts = {})
  delete_project_with_http_info(project_public_id, opts)
  nil
end

#delete_project_with_http_info(project_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Project Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1848

def delete_project_with_http_info(project_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_project ...'
  end
  # verify the required parameter 'project_public_id' is set
  if @api_client.config.client_side_validation && project_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_public_id' when calling DefaultApi.delete_project"
  end
  # resource path
  local_var_path = '/api/v3/projects/{project-public-id}'.sub('{' + 'project-public-id' + '}', CGI.escape(project_public_id.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] || ['api_token']

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

#delete_story(story_public_id, opts = {}) ⇒ nil

Delete Story Delete Story can be used to delete any Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story.

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

    the optional parameters

Returns:

  • (nil) 


1899
1900
1901
1902
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1899

def delete_story(story_public_id, opts = {})
  delete_story_with_http_info(story_public_id, opts)
  nil
end

#delete_story_comment(story_public_id, comment_public_id, opts = {}) ⇒ nil

Delete Story Comment Delete a Comment from any story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

  • (nil) 


1961
1962
1963
1964
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1961

def delete_story_comment(story_public_id, comment_public_id, opts = {})
  delete_story_comment_with_http_info(story_public_id, comment_public_id, opts)
  nil
end

#delete_story_comment_with_http_info(story_public_id, comment_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Story Comment Delete a Comment from any story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1972

def delete_story_comment_with_http_info(story_public_id, comment_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_story_comment ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.delete_story_comment"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.delete_story_comment"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/comments/{comment-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_id.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] || ['api_token']

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

#delete_story_link(story_link_public_id, opts = {}) ⇒ nil

Delete Story Link Removes the relationship between the stories for the given Story Link.

Parameters:

  • story_link_public_id (Integer) —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:

  • (nil) 


2027
2028
2029
2030
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2027

def delete_story_link(story_link_public_id, opts = {})
  delete_story_link_with_http_info(story_link_public_id, opts)
  nil
end

#delete_story_link_with_http_info(story_link_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Story Link Removes the relationship between the stories for the given Story Link.

Parameters:

  • story_link_public_id (Integer) —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2037

def delete_story_link_with_http_info(story_link_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_story_link ...'
  end
  # verify the required parameter 'story_link_public_id' is set
  if @api_client.config.client_side_validation && story_link_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_link_public_id' when calling DefaultApi.delete_story_link"
  end
  # resource path
  local_var_path = '/api/v3/story-links/{story-link-public-id}'.sub('{' + 'story-link-public-id' + '}', CGI.escape(story_link_public_id.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] || ['api_token']

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

#delete_story_reaction(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {}) ⇒ nil

Delete Story Reaction Delete a reaction from any story comment.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

  • (nil) 


2090
2091
2092
2093
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2090

def delete_story_reaction(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {})
  delete_story_reaction_with_http_info(story_public_id, comment_public_id, create_or_delete_story_reaction, opts)
  nil
end

#delete_story_reaction_with_http_info(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Story Reaction Delete a reaction from any story comment.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2102

def delete_story_reaction_with_http_info(story_public_id, comment_public_id, create_or_delete_story_reaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_story_reaction ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.delete_story_reaction"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.delete_story_reaction"
  end
  # verify the required parameter 'create_or_delete_story_reaction' is set
  if @api_client.config.client_side_validation && create_or_delete_story_reaction.nil?
    fail ArgumentError, "Missing the required parameter 'create_or_delete_story_reaction' when calling DefaultApi.delete_story_reaction"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(create_or_delete_story_reaction)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_story_with_http_info(story_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Story Delete Story can be used to delete any Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1909

def delete_story_with_http_info(story_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_story ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.delete_story"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.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] || ['api_token']

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

#delete_task(story_public_id, task_public_id, opts = {}) ⇒ nil

Delete Task Delete Task can be used to delete any previously created Task on a Story.

Parameters:

  • story_public_id (Integer) —

    The unique ID of the Story this Task is associated with.

  • task_public_id (Integer) —

    The unique ID of the Task.

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

    the optional parameters

Returns:

  • (nil) 


2167
2168
2169
2170
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2167

def delete_task(story_public_id, task_public_id, opts = {})
  delete_task_with_http_info(story_public_id, task_public_id, opts)
  nil
end

#delete_task_with_http_info(story_public_id, task_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Task Delete Task can be used to delete any previously created Task on a Story.

Parameters:

  • story_public_id (Integer) —

    The unique ID of the Story this Task is associated with.

  • task_public_id (Integer) —

    The unique ID of the Task.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2178

def delete_task_with_http_info(story_public_id, task_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_task ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.delete_task"
  end
  # verify the required parameter 'task_public_id' is set
  if @api_client.config.client_side_validation && task_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_public_id' when calling DefaultApi.delete_task"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/tasks/{task-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'task-public-id' + '}', CGI.escape(task_public_id.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] || ['api_token']

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

#disable_groups(opts = {}) ⇒ nil

Disable Groups Disables Groups for the current workspace2

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2232
2233
2234
2235
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2232

def disable_groups(opts = {})
  disable_groups_with_http_info(opts)
  nil
end

#disable_groups_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable Groups Disables Groups for the current workspace2

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2241

def disable_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.disable_groups ...'
  end
  # resource path
  local_var_path = '/api/v3/groups/disable'

  # 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] || ['api_token']

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

#disable_iterations(opts = {}) ⇒ nil

Disable Iterations Disables Iterations for the current workspace

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2287
2288
2289
2290
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2287

def disable_iterations(opts = {})
  disable_iterations_with_http_info(opts)
  nil
end

#disable_iterations_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable Iterations Disables Iterations for the current workspace

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2296

def disable_iterations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.disable_iterations ...'
  end
  # resource path
  local_var_path = '/api/v3/iterations/disable'

  # 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] || ['api_token']

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

#disable_story_templates(opts = {}) ⇒ nil

Disable Story Templates Disables the Story Template feature for the given Organization.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2342
2343
2344
2345
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2342

def disable_story_templates(opts = {})
  disable_story_templates_with_http_info(opts)
  nil
end

#disable_story_templates_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable Story Templates Disables the Story Template feature for the given Organization.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2351

def disable_story_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.disable_story_templates ...'
  end
  # resource path
  local_var_path = '/api/v3/entity-templates/disable'

  # 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] || ['api_token']

  new_options = opts.merge(
    :operation => :"DefaultApi.disable_story_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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#disable_story_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#enable_groups(opts = {}) ⇒ nil

Enable Groups Enables Groups for the current workspace2

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2397
2398
2399
2400
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2397

def enable_groups(opts = {})
  enable_groups_with_http_info(opts)
  nil
end

#enable_groups_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Enable Groups Enables Groups for the current workspace2

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2406

def enable_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.enable_groups ...'
  end
  # resource path
  local_var_path = '/api/v3/groups/enable'

  # 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] || ['api_token']

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

#enable_iterations(opts = {}) ⇒ nil

Enable Iterations Enables Iterations for the current workspace

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2452
2453
2454
2455
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2452

def enable_iterations(opts = {})
  enable_iterations_with_http_info(opts)
  nil
end

#enable_iterations_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Enable Iterations Enables Iterations for the current workspace

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2461

def enable_iterations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.enable_iterations ...'
  end
  # resource path
  local_var_path = '/api/v3/iterations/enable'

  # 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] || ['api_token']

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

#enable_story_templates(opts = {}) ⇒ nil

Enable Story Templates Enables the Story Template feature for the given Organization.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2507
2508
2509
2510
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2507

def enable_story_templates(opts = {})
  enable_story_templates_with_http_info(opts)
  nil
end

#enable_story_templates_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Enable Story Templates Enables the Story Template feature for the given Organization.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2516

def enable_story_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.enable_story_templates ...'
  end
  # resource path
  local_var_path = '/api/v3/entity-templates/enable'

  # 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] || ['api_token']

  new_options = opts.merge(
    :operation => :"DefaultApi.enable_story_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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#enable_story_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_category(category_public_id, opts = {}) ⇒ Category

Get Category Get Category returns information about the selected Category.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category.

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

    the optional parameters

Returns:



2563
2564
2565
2566
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2563

def get_category(category_public_id, opts = {})
  data, _status_code, _headers = get_category_with_http_info(category_public_id, opts)
  data
end

#get_category_with_http_info(category_public_id, opts = {}) ⇒ Array<(Category, Integer, Hash)>

Get Category Get Category returns information about the selected Category.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category.

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

    the optional parameters

Returns:

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

    Category data, response status code and response headers



2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2573

def get_category_with_http_info(category_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_category ...'
  end
  # verify the required parameter 'category_public_id' is set
  if @api_client.config.client_side_validation && category_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_public_id' when calling DefaultApi.get_category"
  end
  # resource path
  local_var_path = '/api/v3/categories/{category-public-id}'.sub('{' + 'category-public-id' + '}', CGI.escape(category_public_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] || 'Category'

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

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

#get_current_member_info(opts = {}) ⇒ MemberInfo

Get Current Member Info Returns information about the authenticated member.

Parameters:

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

    the optional parameters

Returns:



2625
2626
2627
2628
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2625

def get_current_member_info(opts = {})
  data, _status_code, _headers = get_current_member_info_with_http_info(opts)
  data
end

#get_current_member_info_with_http_info(opts = {}) ⇒ Array<(MemberInfo, Integer, Hash)>

Get Current Member Info Returns information about the authenticated member.

Parameters:

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

    the optional parameters

Returns:

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

    MemberInfo data, response status code and response headers



2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2634

def get_current_member_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_current_member_info ...'
  end
  # resource path
  local_var_path = '/api/v3/member'

  # 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] || 'MemberInfo'

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

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

#get_entity_template(entity_template_public_id, opts = {}) ⇒ EntityTemplate

Get Entity Template Get Entity Template returns information about a given entity template.

Parameters:

  • entity_template_public_id (String) —

    The unique ID of the entity template.

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

    the optional parameters

Returns:



2683
2684
2685
2686
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2683

def get_entity_template(entity_template_public_id, opts = {})
  data, _status_code, _headers = get_entity_template_with_http_info(entity_template_public_id, opts)
  data
end

#get_entity_template_with_http_info(entity_template_public_id, opts = {}) ⇒ Array<(EntityTemplate, Integer, Hash)>

Get Entity Template Get Entity Template returns information about a given entity template.

Parameters:

  • entity_template_public_id (String) —

    The unique ID of the entity template.

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

    the optional parameters

Returns:

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

    EntityTemplate data, response status code and response headers



2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2693

def get_entity_template_with_http_info(entity_template_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_entity_template ...'
  end
  # verify the required parameter 'entity_template_public_id' is set
  if @api_client.config.client_side_validation && entity_template_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_template_public_id' when calling DefaultApi.get_entity_template"
  end
  # resource path
  local_var_path = '/api/v3/entity-templates/{entity-template-public-id}'.sub('{' + 'entity-template-public-id' + '}', CGI.escape(entity_template_public_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] || 'EntityTemplate'

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

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

#get_epic(epic_public_id, opts = {}) ⇒ Epic

Get Epic Get Epic returns information about the selected Epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



2746
2747
2748
2749
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2746

def get_epic(epic_public_id, opts = {})
  data, _status_code, _headers = get_epic_with_http_info(epic_public_id, opts)
  data
end

#get_epic_comment(epic_public_id, comment_public_id, opts = {}) ⇒ ThreadedComment

Get Epic Comment This endpoint returns information about the selected Epic Comment.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:



2810
2811
2812
2813
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2810

def get_epic_comment(epic_public_id, comment_public_id, opts = {})
  data, _status_code, _headers = get_epic_comment_with_http_info(epic_public_id, comment_public_id, opts)
  data
end

#get_epic_comment_with_http_info(epic_public_id, comment_public_id, opts = {}) ⇒ Array<(ThreadedComment, Integer, Hash)>

Get Epic Comment This endpoint returns information about the selected Epic Comment.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    ThreadedComment data, response status code and response headers



2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2821

def get_epic_comment_with_http_info(epic_public_id, comment_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_epic_comment ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.get_epic_comment"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.get_epic_comment"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/comments/{comment-public-id}'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_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] || 'ThreadedComment'

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

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

#get_epic_with_http_info(epic_public_id, opts = {}) ⇒ Array<(Epic, Integer, Hash)>

Get Epic Get Epic returns information about the selected Epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

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

    Epic data, response status code and response headers



2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2756

def get_epic_with_http_info(epic_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_epic ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.get_epic"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_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] || 'Epic'

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

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

#get_epic_workflow(opts = {}) ⇒ EpicWorkflow

Get Epic Workflow Get Epic Workflow returns the Epic Workflow for the organization.

Parameters:

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

    the optional parameters

Returns:



2877
2878
2879
2880
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2877

def get_epic_workflow(opts = {})
  data, _status_code, _headers = get_epic_workflow_with_http_info(opts)
  data
end

#get_epic_workflow_with_http_info(opts = {}) ⇒ Array<(EpicWorkflow, Integer, Hash)>

Get Epic Workflow Get Epic Workflow returns the Epic Workflow for the organization.

Parameters:

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

    the optional parameters

Returns:

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

    EpicWorkflow data, response status code and response headers



2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2886

def get_epic_workflow_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_epic_workflow ...'
  end
  # resource path
  local_var_path = '/api/v3/epic-workflow'

  # 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] || 'EpicWorkflow'

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

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

#get_external_link_stories(get_external_link_stories_params, opts = {}) ⇒ Array<StorySlim>

Get External Link Stories Get Stories which have a given External Link associated with them.

Parameters:

Returns:



2935
2936
2937
2938
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2935

def get_external_link_stories(get_external_link_stories_params, opts = {})
  data, _status_code, _headers = get_external_link_stories_with_http_info(get_external_link_stories_params, opts)
  data
end

#get_external_link_stories_with_http_info(get_external_link_stories_params, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

Get External Link Stories Get Stories which have a given External Link associated with them.

Parameters:

Returns:

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

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



2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2945

def get_external_link_stories_with_http_info(get_external_link_stories_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_external_link_stories ...'
  end
  # verify the required parameter 'get_external_link_stories_params' is set
  if @api_client.config.client_side_validation && get_external_link_stories_params.nil?
    fail ArgumentError, "Missing the required parameter 'get_external_link_stories_params' when calling DefaultApi.get_external_link_stories"
  end
  # resource path
  local_var_path = '/api/v3/external-link/stories'

  # 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(get_external_link_stories_params)

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

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

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

#get_file(file_public_id, opts = {}) ⇒ UploadedFile

Get File Get File returns information about the selected UploadedFile.

Parameters:

  • file_public_id (Integer) —

    The File’s unique ID.

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

    the optional parameters

Returns:



3003
3004
3005
3006
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3003

def get_file(file_public_id, opts = {})
  data, _status_code, _headers = get_file_with_http_info(file_public_id, opts)
  data
end

#get_file_with_http_info(file_public_id, opts = {}) ⇒ Array<(UploadedFile, Integer, Hash)>

Get File Get File returns information about the selected UploadedFile.

Parameters:

  • file_public_id (Integer) —

    The File’s unique ID.

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

    the optional parameters

Returns:

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

    UploadedFile data, response status code and response headers



3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3013

def get_file_with_http_info(file_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_file ...'
  end
  # verify the required parameter 'file_public_id' is set
  if @api_client.config.client_side_validation && file_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_public_id' when calling DefaultApi.get_file"
  end
  # resource path
  local_var_path = '/api/v3/files/{file-public-id}'.sub('{' + 'file-public-id' + '}', CGI.escape(file_public_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] || 'UploadedFile'

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

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

#get_group(group_public_id, opts = {}) ⇒ Group

Get Group

Parameters:

  • group_public_id (String) —

    The unique ID of the Group.

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

    the optional parameters

Returns:



3065
3066
3067
3068
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3065

def get_group(group_public_id, opts = {})
  data, _status_code, _headers = get_group_with_http_info(group_public_id, opts)
  data
end

#get_group_with_http_info(group_public_id, opts = {}) ⇒ Array<(Group, Integer, Hash)>

Get Group

Parameters:

  • group_public_id (String) —

    The unique ID of the Group.

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

    the optional parameters

Returns:

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

    Group data, response status code and response headers



3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3074

def get_group_with_http_info(group_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_group ...'
  end
  # verify the required parameter 'group_public_id' is set
  if @api_client.config.client_side_validation && group_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_public_id' when calling DefaultApi.get_group"
  end
  # resource path
  local_var_path = '/api/v3/groups/{group-public-id}'.sub('{' + 'group-public-id' + '}', CGI.escape(group_public_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] || 'Group'

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

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

#get_iteration(iteration_public_id, opts = {}) ⇒ Iteration

Get Iteration

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:



3126
3127
3128
3129
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3126

def get_iteration(iteration_public_id, opts = {})
  data, _status_code, _headers = get_iteration_with_http_info(iteration_public_id, opts)
  data
end

#get_iteration_with_http_info(iteration_public_id, opts = {}) ⇒ Array<(Iteration, Integer, Hash)>

Get Iteration

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:

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

    Iteration data, response status code and response headers



3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3135

def get_iteration_with_http_info(iteration_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_iteration ...'
  end
  # verify the required parameter 'iteration_public_id' is set
  if @api_client.config.client_side_validation && iteration_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'iteration_public_id' when calling DefaultApi.get_iteration"
  end
  # resource path
  local_var_path = '/api/v3/iterations/{iteration-public-id}'.sub('{' + 'iteration-public-id' + '}', CGI.escape(iteration_public_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] || 'Iteration'

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

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

#get_label(label_public_id, opts = {}) ⇒ Label

Get Label Get Label returns information about the selected Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:



3188
3189
3190
3191
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3188

def get_label(label_public_id, opts = {})
  data, _status_code, _headers = get_label_with_http_info(label_public_id, opts)
  data
end

#get_label_with_http_info(label_public_id, opts = {}) ⇒ Array<(Label, Integer, Hash)>

Get Label Get Label returns information about the selected Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:

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

    Label data, response status code and response headers



3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3198

def get_label_with_http_info(label_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_label ...'
  end
  # verify the required parameter 'label_public_id' is set
  if @api_client.config.client_side_validation && label_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_public_id' when calling DefaultApi.get_label"
  end
  # resource path
  local_var_path = '/api/v3/labels/{label-public-id}'.sub('{' + 'label-public-id' + '}', CGI.escape(label_public_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] || 'Label'

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

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

#get_linked_file(linked_file_public_id, opts = {}) ⇒ LinkedFile

Get Linked File Get File returns information about the selected Linked File.

Parameters:

  • linked_file_public_id (Integer) —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:



3251
3252
3253
3254
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3251

def get_linked_file(linked_file_public_id, opts = {})
  data, _status_code, _headers = get_linked_file_with_http_info(linked_file_public_id, opts)
  data
end

#get_linked_file_with_http_info(linked_file_public_id, opts = {}) ⇒ Array<(LinkedFile, Integer, Hash)>

Get Linked File Get File returns information about the selected Linked File.

Parameters:

  • linked_file_public_id (Integer) —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:

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

    LinkedFile data, response status code and response headers



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3261

def get_linked_file_with_http_info(linked_file_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_linked_file ...'
  end
  # verify the required parameter 'linked_file_public_id' is set
  if @api_client.config.client_side_validation && linked_file_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'linked_file_public_id' when calling DefaultApi.get_linked_file"
  end
  # resource path
  local_var_path = '/api/v3/linked-files/{linked-file-public-id}'.sub('{' + 'linked-file-public-id' + '}', CGI.escape(linked_file_public_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] || 'LinkedFile'

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

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

#get_member(member_public_id, get_member, opts = {}) ⇒ Member

Get Member Returns information about a Member.

Parameters:

  • member_public_id (String) —

    The Member&#39;s unique ID.

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

    the optional parameters

Returns:



3315
3316
3317
3318
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3315

def get_member(member_public_id, get_member, opts = {})
  data, _status_code, _headers = get_member_with_http_info(member_public_id, get_member, opts)
  data
end

#get_member_with_http_info(member_public_id, get_member, opts = {}) ⇒ Array<(Member, Integer, Hash)>

Get Member Returns information about a Member.

Parameters:

  • member_public_id (String) —

    The Member&#39;s unique ID.

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

    the optional parameters

Returns:

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

    Member data, response status code and response headers



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3326

def get_member_with_http_info(member_public_id, get_member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_member ...'
  end
  # verify the required parameter 'member_public_id' is set
  if @api_client.config.client_side_validation && member_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_public_id' when calling DefaultApi.get_member"
  end
  # verify the required parameter 'get_member' is set
  if @api_client.config.client_side_validation && get_member.nil?
    fail ArgumentError, "Missing the required parameter 'get_member' when calling DefaultApi.get_member"
  end
  # resource path
  local_var_path = '/api/v3/members/{member-public-id}'.sub('{' + 'member-public-id' + '}', CGI.escape(member_public_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(get_member)

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

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

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

#get_milestone(milestone_public_id, opts = {}) ⇒ Milestone

Get Milestone Get Milestone returns information about a chosen Milestone.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:



3388
3389
3390
3391
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3388

def get_milestone(milestone_public_id, opts = {})
  data, _status_code, _headers = get_milestone_with_http_info(milestone_public_id, opts)
  data
end

#get_milestone_with_http_info(milestone_public_id, opts = {}) ⇒ Array<(Milestone, Integer, Hash)>

Get Milestone Get Milestone returns information about a chosen Milestone.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:

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

    Milestone data, response status code and response headers



3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3398

def get_milestone_with_http_info(milestone_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_milestone ...'
  end
  # verify the required parameter 'milestone_public_id' is set
  if @api_client.config.client_side_validation && milestone_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'milestone_public_id' when calling DefaultApi.get_milestone"
  end
  # resource path
  local_var_path = '/api/v3/milestones/{milestone-public-id}'.sub('{' + 'milestone-public-id' + '}', CGI.escape(milestone_public_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] || 'Milestone'

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

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

#get_project(project_public_id, opts = {}) ⇒ Project

Get Project Get Project returns information about the selected Project.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:



3451
3452
3453
3454
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3451

def get_project(project_public_id, opts = {})
  data, _status_code, _headers = get_project_with_http_info(project_public_id, opts)
  data
end

#get_project_with_http_info(project_public_id, opts = {}) ⇒ Array<(Project, Integer, Hash)>

Get Project Get Project returns information about the selected Project.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:

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

    Project data, response status code and response headers



3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3461

def get_project_with_http_info(project_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_project ...'
  end
  # verify the required parameter 'project_public_id' is set
  if @api_client.config.client_side_validation && project_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_public_id' when calling DefaultApi.get_project"
  end
  # resource path
  local_var_path = '/api/v3/projects/{project-public-id}'.sub('{' + 'project-public-id' + '}', CGI.escape(project_public_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] || 'Project'

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

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

#get_repository(repo_public_id, opts = {}) ⇒ Repository

Get Repository Get Repository returns information about the selected Repository.

Parameters:

  • repo_public_id (Integer) —

    The unique ID of the Repository.

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

    the optional parameters

Returns:



3514
3515
3516
3517
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3514

def get_repository(repo_public_id, opts = {})
  data, _status_code, _headers = get_repository_with_http_info(repo_public_id, opts)
  data
end

#get_repository_with_http_info(repo_public_id, opts = {}) ⇒ Array<(Repository, Integer, Hash)>

Get Repository Get Repository returns information about the selected Repository.

Parameters:

  • repo_public_id (Integer) —

    The unique ID of the Repository.

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

    the optional parameters

Returns:

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

    Repository data, response status code and response headers



3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3524

def get_repository_with_http_info(repo_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_repository ...'
  end
  # verify the required parameter 'repo_public_id' is set
  if @api_client.config.client_side_validation && repo_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'repo_public_id' when calling DefaultApi.get_repository"
  end
  # resource path
  local_var_path = '/api/v3/repositories/{repo-public-id}'.sub('{' + 'repo-public-id' + '}', CGI.escape(repo_public_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] || 'Repository'

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

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

#get_story(story_public_id, opts = {}) ⇒ Story

Get Story Get Story returns information about a chosen Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story.

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

    the optional parameters

Returns:



3577
3578
3579
3580
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3577

def get_story(story_public_id, opts = {})
  data, _status_code, _headers = get_story_with_http_info(story_public_id, opts)
  data
end

#get_story_comment(story_public_id, comment_public_id, opts = {}) ⇒ StoryComment

Get Story Comment Get Comment is used to get Comment information.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:



3641
3642
3643
3644
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3641

def get_story_comment(story_public_id, comment_public_id, opts = {})
  data, _status_code, _headers = get_story_comment_with_http_info(story_public_id, comment_public_id, opts)
  data
end

#get_story_comment_with_http_info(story_public_id, comment_public_id, opts = {}) ⇒ Array<(StoryComment, Integer, Hash)>

Get Story Comment Get Comment is used to get Comment information.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    StoryComment data, response status code and response headers



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3652

def get_story_comment_with_http_info(story_public_id, comment_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_story_comment ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.get_story_comment"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.get_story_comment"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/comments/{comment-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_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] || 'StoryComment'

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

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

#get_story_link(story_link_public_id, opts = {}) ⇒ StoryLink

Get Story Link Returns the stories and their relationship for the given Story Link.

Parameters:

  • story_link_public_id (Integer) —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:



3709
3710
3711
3712
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3709

def get_story_link(story_link_public_id, opts = {})
  data, _status_code, _headers = get_story_link_with_http_info(story_link_public_id, opts)
  data
end

#get_story_link_with_http_info(story_link_public_id, opts = {}) ⇒ Array<(StoryLink, Integer, Hash)>

Get Story Link Returns the stories and their relationship for the given Story Link.

Parameters:

  • story_link_public_id (Integer) —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:

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

    StoryLink data, response status code and response headers



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3719

def get_story_link_with_http_info(story_link_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_story_link ...'
  end
  # verify the required parameter 'story_link_public_id' is set
  if @api_client.config.client_side_validation && story_link_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_link_public_id' when calling DefaultApi.get_story_link"
  end
  # resource path
  local_var_path = '/api/v3/story-links/{story-link-public-id}'.sub('{' + 'story-link-public-id' + '}', CGI.escape(story_link_public_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] || 'StoryLink'

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

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

#get_story_with_http_info(story_public_id, opts = {}) ⇒ Array<(Story, Integer, Hash)>

Get Story Get Story returns information about a chosen Story.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story.

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

    the optional parameters

Returns:

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

    Story data, response status code and response headers



3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3587

def get_story_with_http_info(story_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_story ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.get_story"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_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] || 'Story'

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

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

#get_task(story_public_id, task_public_id, opts = {}) ⇒ Task

Get Task Returns information about a chosen Task.

Parameters:

  • story_public_id (Integer) —

    The unique ID of the Story this Task is associated with.

  • task_public_id (Integer) —

    The unique ID of the Task.

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

    the optional parameters

Returns:



3773
3774
3775
3776
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3773

def get_task(story_public_id, task_public_id, opts = {})
  data, _status_code, _headers = get_task_with_http_info(story_public_id, task_public_id, opts)
  data
end

#get_task_with_http_info(story_public_id, task_public_id, opts = {}) ⇒ Array<(Task, Integer, Hash)>

Get Task Returns information about a chosen Task.

Parameters:

  • story_public_id (Integer) —

    The unique ID of the Story this Task is associated with.

  • task_public_id (Integer) —

    The unique ID of the Task.

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

    the optional parameters

Returns:

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

    Task data, response status code and response headers



3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3784

def get_task_with_http_info(story_public_id, task_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_task ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.get_task"
  end
  # verify the required parameter 'task_public_id' is set
  if @api_client.config.client_side_validation && task_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_public_id' when calling DefaultApi.get_task"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/tasks/{task-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'task-public-id' + '}', CGI.escape(task_public_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] || 'Task'

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

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

#get_workflow(workflow_public_id, opts = {}) ⇒ Workflow

Get Workflow Get Workflow returns information about a chosen Workflow.

Parameters:

  • workflow_public_id (Integer) —

    The ID of the Workflow.

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

    the optional parameters

Returns:



3841
3842
3843
3844
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3841

def get_workflow(workflow_public_id, opts = {})
  data, _status_code, _headers = get_workflow_with_http_info(workflow_public_id, opts)
  data
end

#get_workflow_with_http_info(workflow_public_id, opts = {}) ⇒ Array<(Workflow, Integer, Hash)>

Get Workflow Get Workflow returns information about a chosen Workflow.

Parameters:

  • workflow_public_id (Integer) —

    The ID of the Workflow.

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

    the optional parameters

Returns:

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

    Workflow data, response status code and response headers



3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3851

def get_workflow_with_http_info(workflow_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_workflow ...'
  end
  # verify the required parameter 'workflow_public_id' is set
  if @api_client.config.client_side_validation && workflow_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_public_id' when calling DefaultApi.get_workflow"
  end
  # resource path
  local_var_path = '/api/v3/workflows/{workflow-public-id}'.sub('{' + 'workflow-public-id' + '}', CGI.escape(workflow_public_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] || 'Workflow'

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

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

#list_categories(opts = {}) ⇒ Array<Category>

List Categories List Categories returns a list of all Categories and their attributes.

Parameters:

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

    the optional parameters

Returns:



3903
3904
3905
3906
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3903

def list_categories(opts = {})
  data, _status_code, _headers = list_categories_with_http_info(opts)
  data
end

#list_categories_with_http_info(opts = {}) ⇒ Array<(Array<Category>, Integer, Hash)>

List Categories List Categories returns a list of all Categories and their attributes.

Parameters:

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

    the optional parameters

Returns:

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

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



3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3912

def list_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_categories ...'
  end
  # resource path
  local_var_path = '/api/v3/categories'

  # 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] || 'Array<Category>'

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

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

#list_category_milestones(category_public_id, opts = {}) ⇒ Array<Milestone>

List Category Milestones List Category Milestones returns a list of all Milestones with the Category.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category.

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

    the optional parameters

Returns:



3961
3962
3963
3964
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3961

def list_category_milestones(category_public_id, opts = {})
  data, _status_code, _headers = list_category_milestones_with_http_info(category_public_id, opts)
  data
end

#list_category_milestones_with_http_info(category_public_id, opts = {}) ⇒ Array<(Array<Milestone>, Integer, Hash)>

List Category Milestones List Category Milestones returns a list of all Milestones with the Category.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category.

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

    the optional parameters

Returns:

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

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



3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3971

def list_category_milestones_with_http_info(category_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_category_milestones ...'
  end
  # verify the required parameter 'category_public_id' is set
  if @api_client.config.client_side_validation && category_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_public_id' when calling DefaultApi.list_category_milestones"
  end
  # resource path
  local_var_path = '/api/v3/categories/{category-public-id}/milestones'.sub('{' + 'category-public-id' + '}', CGI.escape(category_public_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] || 'Array<Milestone>'

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

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

#list_entity_templates(opts = {}) ⇒ Array<EntityTemplate>

List Entity Templates List all the entity templates for an organization.

Parameters:

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

    the optional parameters

Returns:



4023
4024
4025
4026
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4023

def list_entity_templates(opts = {})
  data, _status_code, _headers = list_entity_templates_with_http_info(opts)
  data
end

#list_entity_templates_with_http_info(opts = {}) ⇒ Array<(Array<EntityTemplate>, Integer, Hash)>

List Entity Templates List all the entity templates for an organization.

Parameters:

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

    the optional parameters

Returns:

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

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



4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4032

def list_entity_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_entity_templates ...'
  end
  # resource path
  local_var_path = '/api/v3/entity-templates'

  # 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] || 'Array<EntityTemplate>'

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

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

#list_epic_comments(epic_public_id, opts = {}) ⇒ Array<ThreadedComment>

List Epic Comments Get a list of all Comments on an Epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



4081
4082
4083
4084
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4081

def list_epic_comments(epic_public_id, opts = {})
  data, _status_code, _headers = list_epic_comments_with_http_info(epic_public_id, opts)
  data
end

#list_epic_comments_with_http_info(epic_public_id, opts = {}) ⇒ Array<(Array<ThreadedComment>, Integer, Hash)>

List Epic Comments Get a list of all Comments on an Epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

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

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



4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4091

def list_epic_comments_with_http_info(epic_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_epic_comments ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.list_epic_comments"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/comments'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_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] || 'Array<ThreadedComment>'

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

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

#list_epic_stories(epic_public_id, get_epic_stories, opts = {}) ⇒ Array<StorySlim>

List Epic Stories Get a list of all Stories in an Epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



4145
4146
4147
4148
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4145

def list_epic_stories(epic_public_id, get_epic_stories, opts = {})
  data, _status_code, _headers = list_epic_stories_with_http_info(epic_public_id, get_epic_stories, opts)
  data
end

#list_epic_stories_with_http_info(epic_public_id, get_epic_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Epic Stories Get a list of all Stories in an Epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

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

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



4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4156

def list_epic_stories_with_http_info(epic_public_id, get_epic_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_epic_stories ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.list_epic_stories"
  end
  # verify the required parameter 'get_epic_stories' is set
  if @api_client.config.client_side_validation && get_epic_stories.nil?
    fail ArgumentError, "Missing the required parameter 'get_epic_stories' when calling DefaultApi.list_epic_stories"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/stories'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_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(get_epic_stories)

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

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

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

#list_epics(list_epics, opts = {}) ⇒ Array<EpicSlim>

List Epics List Epics returns a list of all Epics and their attributes.

Parameters:

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

    the optional parameters

Returns:



4218
4219
4220
4221
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4218

def list_epics(list_epics, opts = {})
  data, _status_code, _headers = list_epics_with_http_info(list_epics, opts)
  data
end

#list_epics_with_http_info(list_epics, opts = {}) ⇒ Array<(Array<EpicSlim>, Integer, Hash)>

List Epics List Epics returns a list of all Epics and their attributes.

Parameters:

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

    the optional parameters

Returns:

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

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



4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4228

def list_epics_with_http_info(list_epics, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_epics ...'
  end
  # verify the required parameter 'list_epics' is set
  if @api_client.config.client_side_validation && list_epics.nil?
    fail ArgumentError, "Missing the required parameter 'list_epics' when calling DefaultApi.list_epics"
  end
  # resource path
  local_var_path = '/api/v3/epics'

  # 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(list_epics)

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

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

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

#list_files(opts = {}) ⇒ Array<UploadedFile>

List Files List Files returns a list of all UploadedFiles in the workspace.

Parameters:

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

    the optional parameters

Returns:



4285
4286
4287
4288
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4285

def list_files(opts = {})
  data, _status_code, _headers = list_files_with_http_info(opts)
  data
end

#list_files_with_http_info(opts = {}) ⇒ Array<(Array<UploadedFile>, Integer, Hash)>

List Files List Files returns a list of all UploadedFiles in the workspace.

Parameters:

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

    the optional parameters

Returns:

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

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



4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4294

def list_files_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_files ...'
  end
  # resource path
  local_var_path = '/api/v3/files'

  # 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] || 'Array<UploadedFile>'

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

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

#list_group_stories(group_public_id, list_group_stories, opts = {}) ⇒ Array<StorySlim>

List Group Stories List the Stories assigned to the Group. (By default, limited to 1,000).

Parameters:

  • group_public_id (String) —

    The unique ID of the Group.

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

    the optional parameters

Returns:



4344
4345
4346
4347
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4344

def list_group_stories(group_public_id, list_group_stories, opts = {})
  data, _status_code, _headers = list_group_stories_with_http_info(group_public_id, list_group_stories, opts)
  data
end

#list_group_stories_with_http_info(group_public_id, list_group_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Group Stories List the Stories assigned to the Group. (By default, limited to 1,000).

Parameters:

  • group_public_id (String) —

    The unique ID of the Group.

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

    the optional parameters

Returns:

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

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



4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4355

def list_group_stories_with_http_info(group_public_id, list_group_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_group_stories ...'
  end
  # verify the required parameter 'group_public_id' is set
  if @api_client.config.client_side_validation && group_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_public_id' when calling DefaultApi.list_group_stories"
  end
  # verify the required parameter 'list_group_stories' is set
  if @api_client.config.client_side_validation && list_group_stories.nil?
    fail ArgumentError, "Missing the required parameter 'list_group_stories' when calling DefaultApi.list_group_stories"
  end
  # resource path
  local_var_path = '/api/v3/groups/{group-public-id}/stories'.sub('{' + 'group-public-id' + '}', CGI.escape(group_public_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(list_group_stories)

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

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

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

#list_groups(opts = {}) ⇒ Array<Group>

List Groups A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.

Parameters:

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

    the optional parameters

Returns:



4416
4417
4418
4419
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4416

def list_groups(opts = {})
  data, _status_code, _headers = list_groups_with_http_info(opts)
  data
end

#list_groups_with_http_info(opts = {}) ⇒ Array<(Array<Group>, Integer, Hash)>

List Groups A group in our API maps to a &quot;Team&quot; within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.

Parameters:

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

    the optional parameters

Returns:

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

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



4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4425

def list_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_groups ...'
  end
  # resource path
  local_var_path = '/api/v3/groups'

  # 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] || 'Array<Group>'

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

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

#list_iteration_stories(iteration_public_id, get_iteration_stories, opts = {}) ⇒ Array<StorySlim>

List Iteration Stories Get a list of all Stories in an Iteration.

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:



4475
4476
4477
4478
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4475

def list_iteration_stories(iteration_public_id, get_iteration_stories, opts = {})
  data, _status_code, _headers = list_iteration_stories_with_http_info(iteration_public_id, get_iteration_stories, opts)
  data
end

#list_iteration_stories_with_http_info(iteration_public_id, get_iteration_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Iteration Stories Get a list of all Stories in an Iteration.

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:

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

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



4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4486

def list_iteration_stories_with_http_info(iteration_public_id, get_iteration_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_iteration_stories ...'
  end
  # verify the required parameter 'iteration_public_id' is set
  if @api_client.config.client_side_validation && iteration_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'iteration_public_id' when calling DefaultApi.list_iteration_stories"
  end
  # verify the required parameter 'get_iteration_stories' is set
  if @api_client.config.client_side_validation && get_iteration_stories.nil?
    fail ArgumentError, "Missing the required parameter 'get_iteration_stories' when calling DefaultApi.list_iteration_stories"
  end
  # resource path
  local_var_path = '/api/v3/iterations/{iteration-public-id}/stories'.sub('{' + 'iteration-public-id' + '}', CGI.escape(iteration_public_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(get_iteration_stories)

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

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

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

#list_iterations(opts = {}) ⇒ Array<IterationSlim>

List Iterations

Parameters:

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

    the optional parameters

Returns:



4546
4547
4548
4549
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4546

def list_iterations(opts = {})
  data, _status_code, _headers = list_iterations_with_http_info(opts)
  data
end

#list_iterations_with_http_info(opts = {}) ⇒ Array<(Array<IterationSlim>, Integer, Hash)>

List Iterations

Parameters:

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

    the optional parameters

Returns:

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

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



4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4554

def list_iterations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_iterations ...'
  end
  # resource path
  local_var_path = '/api/v3/iterations'

  # 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] || 'Array<IterationSlim>'

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

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

#list_label_epics(label_public_id, opts = {}) ⇒ Array<EpicSlim>

List Label Epics List all of the Epics with the Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:



4603
4604
4605
4606
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4603

def list_label_epics(label_public_id, opts = {})
  data, _status_code, _headers = list_label_epics_with_http_info(label_public_id, opts)
  data
end

#list_label_epics_with_http_info(label_public_id, opts = {}) ⇒ Array<(Array<EpicSlim>, Integer, Hash)>

List Label Epics List all of the Epics with the Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:

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

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



4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4613

def list_label_epics_with_http_info(label_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_label_epics ...'
  end
  # verify the required parameter 'label_public_id' is set
  if @api_client.config.client_side_validation && label_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_public_id' when calling DefaultApi.list_label_epics"
  end
  # resource path
  local_var_path = '/api/v3/labels/{label-public-id}/epics'.sub('{' + 'label-public-id' + '}', CGI.escape(label_public_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] || 'Array<EpicSlim>'

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

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

#list_label_stories(label_public_id, get_label_stories, opts = {}) ⇒ Array<StorySlim>

List Label Stories List all of the Stories with the Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:



4667
4668
4669
4670
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4667

def list_label_stories(label_public_id, get_label_stories, opts = {})
  data, _status_code, _headers = list_label_stories_with_http_info(label_public_id, get_label_stories, opts)
  data
end

#list_label_stories_with_http_info(label_public_id, get_label_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Label Stories List all of the Stories with the Label.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label.

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

    the optional parameters

Returns:

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

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



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4678

def list_label_stories_with_http_info(label_public_id, get_label_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_label_stories ...'
  end
  # verify the required parameter 'label_public_id' is set
  if @api_client.config.client_side_validation && label_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_public_id' when calling DefaultApi.list_label_stories"
  end
  # verify the required parameter 'get_label_stories' is set
  if @api_client.config.client_side_validation && get_label_stories.nil?
    fail ArgumentError, "Missing the required parameter 'get_label_stories' when calling DefaultApi.list_label_stories"
  end
  # resource path
  local_var_path = '/api/v3/labels/{label-public-id}/stories'.sub('{' + 'label-public-id' + '}', CGI.escape(label_public_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(get_label_stories)

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

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

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

#list_labels(list_labels, opts = {}) ⇒ Array<Label>

List Labels List Labels returns a list of all Labels and their attributes.

Parameters:

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

    the optional parameters

Returns:



4740
4741
4742
4743
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4740

def list_labels(list_labels, opts = {})
  data, _status_code, _headers = list_labels_with_http_info(list_labels, opts)
  data
end

#list_labels_with_http_info(list_labels, opts = {}) ⇒ Array<(Array<Label>, Integer, Hash)>

List Labels List Labels returns a list of all Labels and their attributes.

Parameters:

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

    the optional parameters

Returns:

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

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



4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4750

def list_labels_with_http_info(list_labels, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_labels ...'
  end
  # verify the required parameter 'list_labels' is set
  if @api_client.config.client_side_validation && list_labels.nil?
    fail ArgumentError, "Missing the required parameter 'list_labels' when calling DefaultApi.list_labels"
  end
  # resource path
  local_var_path = '/api/v3/labels'

  # 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(list_labels)

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

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

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

#list_linked_files(opts = {}) ⇒ Array<LinkedFile>

List Linked Files List Linked Files returns a list of all Linked-Files and their attributes.

Parameters:

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

    the optional parameters

Returns:



4807
4808
4809
4810
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4807

def list_linked_files(opts = {})
  data, _status_code, _headers = list_linked_files_with_http_info(opts)
  data
end

#list_linked_files_with_http_info(opts = {}) ⇒ Array<(Array<LinkedFile>, Integer, Hash)>

List Linked Files List Linked Files returns a list of all Linked-Files and their attributes.

Parameters:

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

    the optional parameters

Returns:

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

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



4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4816

def list_linked_files_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_linked_files ...'
  end
  # resource path
  local_var_path = '/api/v3/linked-files'

  # 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] || 'Array<LinkedFile>'

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

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

#list_members(list_members, opts = {}) ⇒ Array<Member>

List Members List Members returns information about members of the organization.

Parameters:

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

    the optional parameters

Returns:



4865
4866
4867
4868
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4865

def list_members(list_members, opts = {})
  data, _status_code, _headers = list_members_with_http_info(list_members, opts)
  data
end

#list_members_with_http_info(list_members, opts = {}) ⇒ Array<(Array<Member>, Integer, Hash)>

List Members List Members returns information about members of the organization.

Parameters:

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

    the optional parameters

Returns:

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

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



4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4875

def list_members_with_http_info(list_members, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_members ...'
  end
  # verify the required parameter 'list_members' is set
  if @api_client.config.client_side_validation && list_members.nil?
    fail ArgumentError, "Missing the required parameter 'list_members' when calling DefaultApi.list_members"
  end
  # resource path
  local_var_path = '/api/v3/members'

  # 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(list_members)

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

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

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

#list_milestone_epics(milestone_public_id, opts = {}) ⇒ Array<EpicSlim>

List Milestone Epics List all of the Epics within the Milestone.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:



4933
4934
4935
4936
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4933

def list_milestone_epics(milestone_public_id, opts = {})
  data, _status_code, _headers = list_milestone_epics_with_http_info(milestone_public_id, opts)
  data
end

#list_milestone_epics_with_http_info(milestone_public_id, opts = {}) ⇒ Array<(Array<EpicSlim>, Integer, Hash)>

List Milestone Epics List all of the Epics within the Milestone.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:

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

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



4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4943

def list_milestone_epics_with_http_info(milestone_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_milestone_epics ...'
  end
  # verify the required parameter 'milestone_public_id' is set
  if @api_client.config.client_side_validation && milestone_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'milestone_public_id' when calling DefaultApi.list_milestone_epics"
  end
  # resource path
  local_var_path = '/api/v3/milestones/{milestone-public-id}/epics'.sub('{' + 'milestone-public-id' + '}', CGI.escape(milestone_public_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] || 'Array<EpicSlim>'

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

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

#list_milestones(opts = {}) ⇒ Array<Milestone>

List Milestones List Milestones returns a list of all Milestones and their attributes.

Parameters:

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

    the optional parameters

Returns:



4995
4996
4997
4998
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4995

def list_milestones(opts = {})
  data, _status_code, _headers = list_milestones_with_http_info(opts)
  data
end

#list_milestones_with_http_info(opts = {}) ⇒ Array<(Array<Milestone>, Integer, Hash)>

List Milestones List Milestones returns a list of all Milestones and their attributes.

Parameters:

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

    the optional parameters

Returns:

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

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



5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5004

def list_milestones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_milestones ...'
  end
  # resource path
  local_var_path = '/api/v3/milestones'

  # 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] || 'Array<Milestone>'

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

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

#list_projects(opts = {}) ⇒ Array<Project>

List Projects List Projects returns a list of all Projects and their attributes.

Parameters:

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

    the optional parameters

Returns:



5052
5053
5054
5055
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5052

def list_projects(opts = {})
  data, _status_code, _headers = list_projects_with_http_info(opts)
  data
end

#list_projects_with_http_info(opts = {}) ⇒ Array<(Array<Project>, Integer, Hash)>

List Projects List Projects returns a list of all Projects and their attributes.

Parameters:

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

    the optional parameters

Returns:

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

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



5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5061

def list_projects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_projects ...'
  end
  # resource path
  local_var_path = '/api/v3/projects'

  # 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] || 'Array<Project>'

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

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

#list_repositories(opts = {}) ⇒ Array<Repository>

List Repositories List Repositories returns a list of all Repositories and their attributes.

Parameters:

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

    the optional parameters

Returns:



5109
5110
5111
5112
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5109

def list_repositories(opts = {})
  data, _status_code, _headers = list_repositories_with_http_info(opts)
  data
end

#list_repositories_with_http_info(opts = {}) ⇒ Array<(Array<Repository>, Integer, Hash)>

List Repositories List Repositories returns a list of all Repositories and their attributes.

Parameters:

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

    the optional parameters

Returns:

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

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



5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5118

def list_repositories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_repositories ...'
  end
  # resource path
  local_var_path = '/api/v3/repositories'

  # 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] || 'Array<Repository>'

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

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

#list_stories(project_public_id, get_project_stories, opts = {}) ⇒ Array<StorySlim>

List Stories List Stories returns a list of all Stories in a selected Project and their attributes.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:



5168
5169
5170
5171
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5168

def list_stories(project_public_id, get_project_stories, opts = {})
  data, _status_code, _headers = list_stories_with_http_info(project_public_id, get_project_stories, opts)
  data
end

#list_stories_with_http_info(project_public_id, get_project_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Stories List Stories returns a list of all Stories in a selected Project and their attributes.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:

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

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



5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5179

def list_stories_with_http_info(project_public_id, get_project_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_stories ...'
  end
  # verify the required parameter 'project_public_id' is set
  if @api_client.config.client_side_validation && project_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_public_id' when calling DefaultApi.list_stories"
  end
  # verify the required parameter 'get_project_stories' is set
  if @api_client.config.client_side_validation && get_project_stories.nil?
    fail ArgumentError, "Missing the required parameter 'get_project_stories' when calling DefaultApi.list_stories"
  end
  # resource path
  local_var_path = '/api/v3/projects/{project-public-id}/stories'.sub('{' + 'project-public-id' + '}', CGI.escape(project_public_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(get_project_stories)

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

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

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

#list_workflows(opts = {}) ⇒ Array<Workflow>

List Workflows List Workflows returns a list of all Workflows in the organization.

Parameters:

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

    the optional parameters

Returns:



5240
5241
5242
5243
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5240

def list_workflows(opts = {})
  data, _status_code, _headers = list_workflows_with_http_info(opts)
  data
end

#list_workflows_with_http_info(opts = {}) ⇒ Array<(Array<Workflow>, Integer, Hash)>

List Workflows List Workflows returns a list of all Workflows in the organization.

Parameters:

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

    the optional parameters

Returns:

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

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



5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5249

def list_workflows_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_workflows ...'
  end
  # resource path
  local_var_path = '/api/v3/workflows'

  # 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] || 'Array<Workflow>'

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

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

#search(search, opts = {}) ⇒ SearchResults

Search Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the ‘next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parameters:

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

    the optional parameters

Returns:



5298
5299
5300
5301
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5298

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

#search_epics(search, opts = {}) ⇒ EpicSearchResults

Search Epics Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the ‘next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parameters:

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

    the optional parameters

Returns:



5366
5367
5368
5369
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5366

def search_epics(search, opts = {})
  data, _status_code, _headers = search_epics_with_http_info(search, opts)
  data
end

#search_epics_with_http_info(search, opts = {}) ⇒ Array<(EpicSearchResults, Integer, Hash)>

Search Epics Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the &#x60;next&#x60; value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parameters:

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

    the optional parameters

Returns:

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

    EpicSearchResults data, response status code and response headers



5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5376

def search_epics_with_http_info(search, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.search_epics ...'
  end
  # verify the required parameter 'search' is set
  if @api_client.config.client_side_validation && search.nil?
    fail ArgumentError, "Missing the required parameter 'search' when calling DefaultApi.search_epics"
  end
  # resource path
  local_var_path = '/api/v3/search/epics'

  # 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(search)

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

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

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

#search_stories(search, opts = {}) ⇒ StorySearchResults

Search Stories Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the ‘next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parameters:

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

    the optional parameters

Returns:



5434
5435
5436
5437
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5434

def search_stories(search, opts = {})
  data, _status_code, _headers = search_stories_with_http_info(search, opts)
  data
end

#search_stories_old(search_stories, opts = {}) ⇒ Array<StorySlim>

Search Stories (Old) Search Stories lets you search Stories based on desired parameters.

Parameters:

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

    the optional parameters

Returns:



5502
5503
5504
5505
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5502

def search_stories_old(search_stories, opts = {})
  data, _status_code, _headers = search_stories_old_with_http_info(search_stories, opts)
  data
end

#search_stories_old_with_http_info(search_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

Search Stories (Old) Search Stories lets you search Stories based on desired parameters.

Parameters:

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

    the optional parameters

Returns:

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

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



5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5512

def search_stories_old_with_http_info(search_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.search_stories_old ...'
  end
  # verify the required parameter 'search_stories' is set
  if @api_client.config.client_side_validation && search_stories.nil?
    fail ArgumentError, "Missing the required parameter 'search_stories' when calling DefaultApi.search_stories_old"
  end
  # resource path
  local_var_path = '/api/v3/stories/search'

  # 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(search_stories)

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

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

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

#search_stories_with_http_info(search, opts = {}) ⇒ Array<(StorySearchResults, Integer, Hash)>

Search Stories Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the &#x60;next&#x60; value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parameters:

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

    the optional parameters

Returns:

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

    StorySearchResults data, response status code and response headers



5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5444

def search_stories_with_http_info(search, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.search_stories ...'
  end
  # verify the required parameter 'search' is set
  if @api_client.config.client_side_validation && search.nil?
    fail ArgumentError, "Missing the required parameter 'search' when calling DefaultApi.search_stories"
  end
  # resource path
  local_var_path = '/api/v3/search/stories'

  # 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(search)

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

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

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

#search_with_http_info(search, opts = {}) ⇒ Array<(SearchResults, Integer, Hash)>

Search Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the &#x60;next&#x60; value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Parameters:

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

    the optional parameters

Returns:

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

    SearchResults data, response status code and response headers



5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5308

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

  # 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(search)

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

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

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

#story_history(story_public_id, opts = {}) ⇒ Array<History>

Story History

Parameters:

  • story_public_id (Integer) —

    The ID of the Story.

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

    the optional parameters

Returns:



5569
5570
5571
5572
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5569

def story_history(story_public_id, opts = {})
  data, _status_code, _headers = story_history_with_http_info(story_public_id, opts)
  data
end

#story_history_with_http_info(story_public_id, opts = {}) ⇒ Array<(Array<History>, Integer, Hash)>

Story History

Parameters:

  • story_public_id (Integer) —

    The ID of the Story.

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

    the optional parameters

Returns:

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

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



5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5578

def story_history_with_http_info(story_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.story_history ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.story_history"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/history'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_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] || 'Array<History>'

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

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

#unlink_productboard_from_epic(epic_public_id, opts = {}) ⇒ nil

Unlink Productboard from Epic This endpoint allows you to unlink a productboard epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

  • (nil) 


5631
5632
5633
5634
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5631

def unlink_productboard_from_epic(epic_public_id, opts = {})
  unlink_productboard_from_epic_with_http_info(epic_public_id, opts)
  nil
end

#unlink_productboard_from_epic_with_http_info(epic_public_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unlink Productboard from Epic This endpoint allows you to unlink a productboard epic.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5641

def unlink_productboard_from_epic_with_http_info(epic_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unlink_productboard_from_epic ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.unlink_productboard_from_epic"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/unlink-productboard'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_id.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] || ['api_token']

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

#update_category(category_public_id, update_category, opts = {}) ⇒ Category

Update Category Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category you wish to update.

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

    the optional parameters

Returns:



5693
5694
5695
5696
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5693

def update_category(category_public_id, update_category, opts = {})
  data, _status_code, _headers = update_category_with_http_info(category_public_id, update_category, opts)
  data
end

#update_category_with_http_info(category_public_id, update_category, opts = {}) ⇒ Array<(Category, Integer, Hash)>

Update Category Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.

Parameters:

  • category_public_id (Integer) —

    The unique ID of the Category you wish to update.

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

    the optional parameters

Returns:

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

    Category data, response status code and response headers



5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5704

def update_category_with_http_info(category_public_id, update_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_category ...'
  end
  # verify the required parameter 'category_public_id' is set
  if @api_client.config.client_side_validation && category_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'category_public_id' when calling DefaultApi.update_category"
  end
  # verify the required parameter 'update_category' is set
  if @api_client.config.client_side_validation && update_category.nil?
    fail ArgumentError, "Missing the required parameter 'update_category' when calling DefaultApi.update_category"
  end
  # resource path
  local_var_path = '/api/v3/categories/{category-public-id}'.sub('{' + 'category-public-id' + '}', CGI.escape(category_public_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(update_category)

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

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

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

#update_entity_template(entity_template_public_id, update_entity_template, opts = {}) ⇒ EntityTemplate

Update Entity Template Update an entity template’s name or its contents.

Parameters:

  • entity_template_public_id (String) —

    The unique ID of the template to be updated.

  • update_entity_template (UpdateEntityTemplate) —

    Request parameters for changing either a template&#39;s name or any of the attributes it is designed to pre-populate.

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

    the optional parameters

Returns:



5767
5768
5769
5770
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5767

def update_entity_template(entity_template_public_id, update_entity_template, opts = {})
  data, _status_code, _headers = update_entity_template_with_http_info(entity_template_public_id, update_entity_template, opts)
  data
end

#update_entity_template_with_http_info(entity_template_public_id, update_entity_template, opts = {}) ⇒ Array<(EntityTemplate, Integer, Hash)>

Update Entity Template Update an entity template&#39;s name or its contents.

Parameters:

  • entity_template_public_id (String) —

    The unique ID of the template to be updated.

  • update_entity_template (UpdateEntityTemplate) —

    Request parameters for changing either a template&#39;s name or any of the attributes it is designed to pre-populate.

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

    the optional parameters

Returns:

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

    EntityTemplate data, response status code and response headers



5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5778

def update_entity_template_with_http_info(entity_template_public_id, update_entity_template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_entity_template ...'
  end
  # verify the required parameter 'entity_template_public_id' is set
  if @api_client.config.client_side_validation && entity_template_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_template_public_id' when calling DefaultApi.update_entity_template"
  end
  # verify the required parameter 'update_entity_template' is set
  if @api_client.config.client_side_validation && update_entity_template.nil?
    fail ArgumentError, "Missing the required parameter 'update_entity_template' when calling DefaultApi.update_entity_template"
  end
  # resource path
  local_var_path = '/api/v3/entity-templates/{entity-template-public-id}'.sub('{' + 'entity-template-public-id' + '}', CGI.escape(entity_template_public_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(update_entity_template)

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

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

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

#update_epic(epic_public_id, update_epic, opts = {}) ⇒ Epic

Update Epic Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



5841
5842
5843
5844
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5841

def update_epic(epic_public_id, update_epic, opts = {})
  data, _status_code, _headers = update_epic_with_http_info(epic_public_id, update_epic, opts)
  data
end

#update_epic_comment(epic_public_id, comment_public_id, update_comment, opts = {}) ⇒ ThreadedComment

Update Epic Comment This endpoint allows you to update a threaded Comment on an Epic.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:



5916
5917
5918
5919
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5916

def update_epic_comment(epic_public_id, comment_public_id, update_comment, opts = {})
  data, _status_code, _headers = update_epic_comment_with_http_info(epic_public_id, comment_public_id, update_comment, opts)
  data
end

#update_epic_comment_with_http_info(epic_public_id, comment_public_id, update_comment, opts = {}) ⇒ Array<(ThreadedComment, Integer, Hash)>

Update Epic Comment This endpoint allows you to update a threaded Comment on an Epic.

Parameters:

  • epic_public_id (Integer) —

    The ID of the associated Epic.

  • comment_public_id (Integer) —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    ThreadedComment data, response status code and response headers



5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5928

def update_epic_comment_with_http_info(epic_public_id, comment_public_id, update_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_epic_comment ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.update_epic_comment"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.update_epic_comment"
  end
  # verify the required parameter 'update_comment' is set
  if @api_client.config.client_side_validation && update_comment.nil?
    fail ArgumentError, "Missing the required parameter 'update_comment' when calling DefaultApi.update_epic_comment"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}/comments/{comment-public-id}'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_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(update_comment)

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

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

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

#update_epic_with_http_info(epic_public_id, update_epic, opts = {}) ⇒ Array<(Epic, Integer, Hash)>

Update Epic Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.

Parameters:

  • epic_public_id (Integer) —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

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

    Epic data, response status code and response headers



5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5852

def update_epic_with_http_info(epic_public_id, update_epic, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_epic ...'
  end
  # verify the required parameter 'epic_public_id' is set
  if @api_client.config.client_side_validation && epic_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'epic_public_id' when calling DefaultApi.update_epic"
  end
  # verify the required parameter 'update_epic' is set
  if @api_client.config.client_side_validation && update_epic.nil?
    fail ArgumentError, "Missing the required parameter 'update_epic' when calling DefaultApi.update_epic"
  end
  # resource path
  local_var_path = '/api/v3/epics/{epic-public-id}'.sub('{' + 'epic-public-id' + '}', CGI.escape(epic_public_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(update_epic)

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

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

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

#update_file(file_public_id, update_file, opts = {}) ⇒ UploadedFile

Update File Update File updates the properties of an UploadedFile (but not its content).

Parameters:

  • file_public_id (Integer) —

    The unique ID assigned to the file in Shortcut.

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

    the optional parameters

Returns:



5995
5996
5997
5998
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5995

def update_file(file_public_id, update_file, opts = {})
  data, _status_code, _headers = update_file_with_http_info(file_public_id, update_file, opts)
  data
end

#update_file_with_http_info(file_public_id, update_file, opts = {}) ⇒ Array<(UploadedFile, Integer, Hash)>

Update File Update File updates the properties of an UploadedFile (but not its content).

Parameters:

  • file_public_id (Integer) —

    The unique ID assigned to the file in Shortcut.

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

    the optional parameters

Returns:

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

    UploadedFile data, response status code and response headers



6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6006

def update_file_with_http_info(file_public_id, update_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_file ...'
  end
  # verify the required parameter 'file_public_id' is set
  if @api_client.config.client_side_validation && file_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_public_id' when calling DefaultApi.update_file"
  end
  # verify the required parameter 'update_file' is set
  if @api_client.config.client_side_validation && update_file.nil?
    fail ArgumentError, "Missing the required parameter 'update_file' when calling DefaultApi.update_file"
  end
  # resource path
  local_var_path = '/api/v3/files/{file-public-id}'.sub('{' + 'file-public-id' + '}', CGI.escape(file_public_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(update_file)

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

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

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

#update_group(group_public_id, update_group, opts = {}) ⇒ Group

Update Group

Parameters:

  • group_public_id (String) —

    The unique ID of the Group.

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

    the optional parameters

Returns:



6068
6069
6070
6071
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6068

def update_group(group_public_id, update_group, opts = {})
  data, _status_code, _headers = update_group_with_http_info(group_public_id, update_group, opts)
  data
end

#update_group_with_http_info(group_public_id, update_group, opts = {}) ⇒ Array<(Group, Integer, Hash)>

Update Group

Parameters:

  • group_public_id (String) —

    The unique ID of the Group.

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

    the optional parameters

Returns:

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

    Group data, response status code and response headers



6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6078

def update_group_with_http_info(group_public_id, update_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_group ...'
  end
  # verify the required parameter 'group_public_id' is set
  if @api_client.config.client_side_validation && group_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_public_id' when calling DefaultApi.update_group"
  end
  # verify the required parameter 'update_group' is set
  if @api_client.config.client_side_validation && update_group.nil?
    fail ArgumentError, "Missing the required parameter 'update_group' when calling DefaultApi.update_group"
  end
  # resource path
  local_var_path = '/api/v3/groups/{group-public-id}'.sub('{' + 'group-public-id' + '}', CGI.escape(group_public_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(update_group)

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

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

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

#update_iteration(iteration_public_id, update_iteration, opts = {}) ⇒ Iteration

Update Iteration

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:



6140
6141
6142
6143
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6140

def update_iteration(iteration_public_id, update_iteration, opts = {})
  data, _status_code, _headers = update_iteration_with_http_info(iteration_public_id, update_iteration, opts)
  data
end

#update_iteration_with_http_info(iteration_public_id, update_iteration, opts = {}) ⇒ Array<(Iteration, Integer, Hash)>

Update Iteration

Parameters:

  • iteration_public_id (Integer) —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:

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

    Iteration data, response status code and response headers



6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6150

def update_iteration_with_http_info(iteration_public_id, update_iteration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_iteration ...'
  end
  # verify the required parameter 'iteration_public_id' is set
  if @api_client.config.client_side_validation && iteration_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'iteration_public_id' when calling DefaultApi.update_iteration"
  end
  # verify the required parameter 'update_iteration' is set
  if @api_client.config.client_side_validation && update_iteration.nil?
    fail ArgumentError, "Missing the required parameter 'update_iteration' when calling DefaultApi.update_iteration"
  end
  # resource path
  local_var_path = '/api/v3/iterations/{iteration-public-id}'.sub('{' + 'iteration-public-id' + '}', CGI.escape(iteration_public_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(update_iteration)

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

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

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

#update_label(label_public_id, update_label, opts = {}) ⇒ Label

Update Label Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label you wish to update.

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

    the optional parameters

Returns:



6213
6214
6215
6216
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6213

def update_label(label_public_id, update_label, opts = {})
  data, _status_code, _headers = update_label_with_http_info(label_public_id, update_label, opts)
  data
end

#update_label_with_http_info(label_public_id, update_label, opts = {}) ⇒ Array<(Label, Integer, Hash)>

Update Label Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.

Parameters:

  • label_public_id (Integer) —

    The unique ID of the Label you wish to update.

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

    the optional parameters

Returns:

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

    Label data, response status code and response headers



6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6224

def update_label_with_http_info(label_public_id, update_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_label ...'
  end
  # verify the required parameter 'label_public_id' is set
  if @api_client.config.client_side_validation && label_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_public_id' when calling DefaultApi.update_label"
  end
  # verify the required parameter 'update_label' is set
  if @api_client.config.client_side_validation && update_label.nil?
    fail ArgumentError, "Missing the required parameter 'update_label' when calling DefaultApi.update_label"
  end
  # resource path
  local_var_path = '/api/v3/labels/{label-public-id}'.sub('{' + 'label-public-id' + '}', CGI.escape(label_public_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(update_label)

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

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

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

#update_linked_file(linked_file_public_id, update_linked_file, opts = {}) ⇒ LinkedFile

Update Linked File Updated Linked File allows you to update properties of a previously attached Linked-File.

Parameters:

  • linked_file_public_id (Integer) —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:



6287
6288
6289
6290
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6287

def update_linked_file(linked_file_public_id, update_linked_file, opts = {})
  data, _status_code, _headers = update_linked_file_with_http_info(linked_file_public_id, update_linked_file, opts)
  data
end

#update_linked_file_with_http_info(linked_file_public_id, update_linked_file, opts = {}) ⇒ Array<(LinkedFile, Integer, Hash)>

Update Linked File Updated Linked File allows you to update properties of a previously attached Linked-File.

Parameters:

  • linked_file_public_id (Integer) —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:

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

    LinkedFile data, response status code and response headers



6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6298

def update_linked_file_with_http_info(linked_file_public_id, update_linked_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_linked_file ...'
  end
  # verify the required parameter 'linked_file_public_id' is set
  if @api_client.config.client_side_validation && linked_file_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'linked_file_public_id' when calling DefaultApi.update_linked_file"
  end
  # verify the required parameter 'update_linked_file' is set
  if @api_client.config.client_side_validation && update_linked_file.nil?
    fail ArgumentError, "Missing the required parameter 'update_linked_file' when calling DefaultApi.update_linked_file"
  end
  # resource path
  local_var_path = '/api/v3/linked-files/{linked-file-public-id}'.sub('{' + 'linked-file-public-id' + '}', CGI.escape(linked_file_public_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(update_linked_file)

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

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

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

#update_milestone(milestone_public_id, update_milestone, opts = {}) ⇒ Milestone

Update Milestone Update Milestone can be used to update Milestone properties.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:



6361
6362
6363
6364
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6361

def update_milestone(milestone_public_id, update_milestone, opts = {})
  data, _status_code, _headers = update_milestone_with_http_info(milestone_public_id, update_milestone, opts)
  data
end

#update_milestone_with_http_info(milestone_public_id, update_milestone, opts = {}) ⇒ Array<(Milestone, Integer, Hash)>

Update Milestone Update Milestone can be used to update Milestone properties.

Parameters:

  • milestone_public_id (Integer) —

    The ID of the Milestone.

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

    the optional parameters

Returns:

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

    Milestone data, response status code and response headers



6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6372

def update_milestone_with_http_info(milestone_public_id, update_milestone, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_milestone ...'
  end
  # verify the required parameter 'milestone_public_id' is set
  if @api_client.config.client_side_validation && milestone_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'milestone_public_id' when calling DefaultApi.update_milestone"
  end
  # verify the required parameter 'update_milestone' is set
  if @api_client.config.client_side_validation && update_milestone.nil?
    fail ArgumentError, "Missing the required parameter 'update_milestone' when calling DefaultApi.update_milestone"
  end
  # resource path
  local_var_path = '/api/v3/milestones/{milestone-public-id}'.sub('{' + 'milestone-public-id' + '}', CGI.escape(milestone_public_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(update_milestone)

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

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

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

#update_multiple_stories(update_stories, opts = {}) ⇒ Array<StorySlim>

Update Multiple Stories Update Multiple Stories allows you to make changes to numerous stories at once.

Parameters:

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

    the optional parameters

Returns:



6434
6435
6436
6437
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6434

def update_multiple_stories(update_stories, opts = {})
  data, _status_code, _headers = update_multiple_stories_with_http_info(update_stories, opts)
  data
end

#update_multiple_stories_with_http_info(update_stories, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

Update Multiple Stories Update Multiple Stories allows you to make changes to numerous stories at once.

Parameters:

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

    the optional parameters

Returns:

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

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



6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6444

def update_multiple_stories_with_http_info(update_stories, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_multiple_stories ...'
  end
  # verify the required parameter 'update_stories' is set
  if @api_client.config.client_side_validation && update_stories.nil?
    fail ArgumentError, "Missing the required parameter 'update_stories' when calling DefaultApi.update_multiple_stories"
  end
  # resource path
  local_var_path = '/api/v3/stories/bulk'

  # 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(update_stories)

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

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

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

#update_project(project_public_id, update_project, opts = {}) ⇒ Project

Update Project Update Project can be used to change properties of a Project.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:



6503
6504
6505
6506
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6503

def update_project(project_public_id, update_project, opts = {})
  data, _status_code, _headers = update_project_with_http_info(project_public_id, update_project, opts)
  data
end

#update_project_with_http_info(project_public_id, update_project, opts = {}) ⇒ Array<(Project, Integer, Hash)>

Update Project Update Project can be used to change properties of a Project.

Parameters:

  • project_public_id (Integer) —

    The unique ID of the Project.

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

    the optional parameters

Returns:

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

    Project data, response status code and response headers



6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6514

def update_project_with_http_info(project_public_id, update_project, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_project ...'
  end
  # verify the required parameter 'project_public_id' is set
  if @api_client.config.client_side_validation && project_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_public_id' when calling DefaultApi.update_project"
  end
  # verify the required parameter 'update_project' is set
  if @api_client.config.client_side_validation && update_project.nil?
    fail ArgumentError, "Missing the required parameter 'update_project' when calling DefaultApi.update_project"
  end
  # resource path
  local_var_path = '/api/v3/projects/{project-public-id}'.sub('{' + 'project-public-id' + '}', CGI.escape(project_public_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(update_project)

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

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

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

#update_story(story_public_id, update_story, opts = {}) ⇒ Story

Update Story Update Story can be used to update Story properties.

Parameters:

  • story_public_id (Integer) —

    The unique identifier of this story.

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

    the optional parameters

Returns:



6577
6578
6579
6580
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6577

def update_story(story_public_id, update_story, opts = {})
  data, _status_code, _headers = update_story_with_http_info(story_public_id, update_story, opts)
  data
end

#update_story_comment(story_public_id, comment_public_id, update_story_comment, opts = {}) ⇒ StoryComment

Update Story Comment Update Comment replaces the text of the existing Comment.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment

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

    the optional parameters

Returns:



6652
6653
6654
6655
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6652

def update_story_comment(story_public_id, comment_public_id, update_story_comment, opts = {})
  data, _status_code, _headers = update_story_comment_with_http_info(story_public_id, comment_public_id, update_story_comment, opts)
  data
end

#update_story_comment_with_http_info(story_public_id, comment_public_id, update_story_comment, opts = {}) ⇒ Array<(StoryComment, Integer, Hash)>

Update Story Comment Update Comment replaces the text of the existing Comment.

Parameters:

  • story_public_id (Integer) —

    The ID of the Story that the Comment is in.

  • comment_public_id (Integer) —

    The ID of the Comment

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

    the optional parameters

Returns:

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

    StoryComment data, response status code and response headers



6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6664

def update_story_comment_with_http_info(story_public_id, comment_public_id, update_story_comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_story_comment ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.update_story_comment"
  end
  # verify the required parameter 'comment_public_id' is set
  if @api_client.config.client_side_validation && comment_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_public_id' when calling DefaultApi.update_story_comment"
  end
  # verify the required parameter 'update_story_comment' is set
  if @api_client.config.client_side_validation && update_story_comment.nil?
    fail ArgumentError, "Missing the required parameter 'update_story_comment' when calling DefaultApi.update_story_comment"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/comments/{comment-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'comment-public-id' + '}', CGI.escape(comment_public_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(update_story_comment)

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

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

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

#update_story_link(story_link_public_id, update_story_link, opts = {}) ⇒ StoryLink

Update Story Link Updates the stories and/or the relationship for the given Story Link.

Parameters:

  • story_link_public_id (Integer) —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:



6731
6732
6733
6734
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6731

def update_story_link(story_link_public_id, update_story_link, opts = {})
  data, _status_code, _headers = update_story_link_with_http_info(story_link_public_id, update_story_link, opts)
  data
end

#update_story_link_with_http_info(story_link_public_id, update_story_link, opts = {}) ⇒ Array<(StoryLink, Integer, Hash)>

Update Story Link Updates the stories and/or the relationship for the given Story Link.

Parameters:

  • story_link_public_id (Integer) —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:

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

    StoryLink data, response status code and response headers



6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6742

def update_story_link_with_http_info(story_link_public_id, update_story_link, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_story_link ...'
  end
  # verify the required parameter 'story_link_public_id' is set
  if @api_client.config.client_side_validation && story_link_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_link_public_id' when calling DefaultApi.update_story_link"
  end
  # verify the required parameter 'update_story_link' is set
  if @api_client.config.client_side_validation && update_story_link.nil?
    fail ArgumentError, "Missing the required parameter 'update_story_link' when calling DefaultApi.update_story_link"
  end
  # resource path
  local_var_path = '/api/v3/story-links/{story-link-public-id}'.sub('{' + 'story-link-public-id' + '}', CGI.escape(story_link_public_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(update_story_link)

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

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

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

#update_story_with_http_info(story_public_id, update_story, opts = {}) ⇒ Array<(Story, Integer, Hash)>

Update Story Update Story can be used to update Story properties.

Parameters:

  • story_public_id (Integer) —

    The unique identifier of this story.

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

    the optional parameters

Returns:

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

    Story data, response status code and response headers



6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6588

def update_story_with_http_info(story_public_id, update_story, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_story ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.update_story"
  end
  # verify the required parameter 'update_story' is set
  if @api_client.config.client_side_validation && update_story.nil?
    fail ArgumentError, "Missing the required parameter 'update_story' when calling DefaultApi.update_story"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_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(update_story)

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

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

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

#update_task(story_public_id, task_public_id, update_task, opts = {}) ⇒ Task

Update Task Update Task can be used to update Task properties.

Parameters:

  • story_public_id (Integer) —

    The unique identifier of the parent Story.

  • task_public_id (Integer) —

    The unique identifier of the Task you wish to update.

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

    the optional parameters

Returns:



6806
6807
6808
6809
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6806

def update_task(story_public_id, task_public_id, update_task, opts = {})
  data, _status_code, _headers = update_task_with_http_info(story_public_id, task_public_id, update_task, opts)
  data
end

#update_task_with_http_info(story_public_id, task_public_id, update_task, opts = {}) ⇒ Array<(Task, Integer, Hash)>

Update Task Update Task can be used to update Task properties.

Parameters:

  • story_public_id (Integer) —

    The unique identifier of the parent Story.

  • task_public_id (Integer) —

    The unique identifier of the Task you wish to update.

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

    the optional parameters

Returns:

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

    Task data, response status code and response headers



6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6818

def update_task_with_http_info(story_public_id, task_public_id, update_task, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_task ...'
  end
  # verify the required parameter 'story_public_id' is set
  if @api_client.config.client_side_validation && story_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_public_id' when calling DefaultApi.update_task"
  end
  # verify the required parameter 'task_public_id' is set
  if @api_client.config.client_side_validation && task_public_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_public_id' when calling DefaultApi.update_task"
  end
  # verify the required parameter 'update_task' is set
  if @api_client.config.client_side_validation && update_task.nil?
    fail ArgumentError, "Missing the required parameter 'update_task' when calling DefaultApi.update_task"
  end
  # resource path
  local_var_path = '/api/v3/stories/{story-public-id}/tasks/{task-public-id}'.sub('{' + 'story-public-id' + '}', CGI.escape(story_public_id.to_s)).sub('{' + 'task-public-id' + '}', CGI.escape(task_public_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(update_task)

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

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

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

#upload_files(file0, opts = {}) ⇒ Array<UploadedFile>

Upload Files Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each ‘file` key should contain a separate file. Each UploadedFile’s name comes from the Content-Disposition header "filename" directive for that field.

Parameters:

  • file0 (File) —

    A file upload. At least one is required.

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

    the optional parameters

Options Hash (opts):

  • :story_id (Integer) —

    The story ID that these files will be associated with.

  • :file1 (File) —

    Optional additional files.

  • :file2 (File) —

    Optional additional files.

  • :file3 (File) —

    Optional additional files.

Returns:



6888
6889
6890
6891
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6888

def upload_files(file0, opts = {})
  data, _status_code, _headers = upload_files_with_http_info(file0, opts)
  data
end

#upload_files_with_http_info(file0, opts = {}) ⇒ Array<(Array<UploadedFile>, Integer, Hash)>

Upload Files Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each &#x60;file&#x60; key should contain a separate file. Each UploadedFile&#39;s name comes from the Content-Disposition header &quot;filename&quot; directive for that field.

Parameters:

  • file0 (File) —

    A file upload. At least one is required.

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

    the optional parameters

Options Hash (opts):

  • :story_id (Integer) —

    The story ID that these files will be associated with.

  • :file1 (File) —

    Optional additional files.

  • :file2 (File) —

    Optional additional files.

  • :file3 (File) —

    Optional additional files.

Returns:

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

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



6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6902

def upload_files_with_http_info(file0, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.upload_files ...'
  end
  # verify the required parameter 'file0' is set
  if @api_client.config.client_side_validation && file0.nil?
    fail ArgumentError, "Missing the required parameter 'file0' when calling DefaultApi.upload_files"
  end
  # resource path
  local_var_path = '/api/v3/files'

  # 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(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file0'] = file0
  form_params['story_id'] = opts[:'story_id'] if !opts[:'story_id'].nil?
  form_params['file1'] = opts[:'file1'] if !opts[:'file1'].nil?
  form_params['file2'] = opts[:'file2'] if !opts[:'file2'].nil?
  form_params['file3'] = opts[:'file3'] if !opts[:'file3'].nil?

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

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

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

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