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.



16
17
18
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

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

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

Parameters:

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 24

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    Category data, response status code and response headers



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 34

def create_category_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_category ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ EntityTemplate

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

Parameters:

  • body —

    Request paramaters for creating an entirely new entity template.

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 82

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

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

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

Parameters:

  • body —

    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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 92

def create_entity_template_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_entity_template ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Epic

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

Parameters:

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

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 140

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

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

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

Parameters:

  • body
  • epic_public_id —

    The ID of the associated Epic.

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

    the optional parameters

Returns:



199
200
201
202
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 199

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

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

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

Parameters:

  • body
  • epic_public_id —

    The ID of the associated Epic.

  • comment_public_id —

    The ID of the parent Epic Comment.

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 264

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

#create_epic_comment_comment_with_http_info(body, epic_public_id, comment_public_id, 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:

  • body
  • epic_public_id —

    The ID of the associated Epic.

  • comment_public_id —

    The ID of the parent Epic Comment.

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

    the optional parameters

Returns:

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

    ThreadedComment data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 276

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, epic_public_id, opts = {}) ⇒ Array<(ThreadedComment, Integer, Hash)>

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

Parameters:

  • body
  • epic_public_id —

    The ID of the associated Epic.

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

    the optional parameters

Returns:

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

    ThreadedComment data, response status code and response headers



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 210

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Array<(Epic, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

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

    Epic data, response status code and response headers



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 150

def create_epic_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_epic ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Group

Create Group

Parameters:

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

    the optional parameters

Returns:



331
332
333
334
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 331

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

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

Create Group

Parameters:

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

    the optional parameters

Returns:

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

    Group data, response status code and response headers



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 340

def create_group_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_group ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Iteration

Create Iteration

Parameters:

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

    the optional parameters

Returns:



387
388
389
390
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 387

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

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

Create Iteration

Parameters:

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

    the optional parameters

Returns:

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

    Iteration data, response status code and response headers



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

def create_iteration_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_iteration ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Label

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

Parameters:

  • body —

    Request parameters for creating a Label on a Shortcut Story.

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

    the optional parameters

Returns:



444
445
446
447
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 444

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

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

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

Parameters:

  • body —

    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



454
455
456
457
458
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 454

def create_label_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_label ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ LinkedFile

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

Parameters:

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

    the optional parameters

Returns:



502
503
504
505
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 502

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    LinkedFile data, response status code and response headers



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 512

def create_linked_file_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_linked_file ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Milestone

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

Parameters:

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

    the optional parameters

Returns:



560
561
562
563
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 560

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    Milestone data, response status code and response headers



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 570

def create_milestone_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_milestone ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, 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:

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

    the optional parameters

Returns:



618
619
620
621
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 618

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

#create_multiple_stories_with_http_info(body, 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:

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

    the optional parameters

Returns:

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

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



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 628

def create_multiple_stories_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_multiple_stories ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Project

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

Parameters:

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

    the optional parameters

Returns:



676
677
678
679
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 676

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    Project data, response status code and response headers



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
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 686

def create_project_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_project ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Story

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

Parameters:

  • body —

    Request parameters for creating a story.

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

    the optional parameters

Returns:



734
735
736
737
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 734

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

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

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

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

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

    the optional parameters

Returns:



793
794
795
796
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 793

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

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

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

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

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

    the optional parameters

Returns:

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

    StoryComment data, response status code and response headers



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 804

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, 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:

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

    the optional parameters

Returns:



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

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

#create_story_link_with_http_info(body, 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:

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

    the optional parameters

Returns:

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

    StoryLink data, response status code and response headers



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

def create_story_link_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_story_link ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, story_public_id, comment_public_id, opts = {}) ⇒ Array<StoryReaction>

Create Story Reaction Create a reaction to a story comment.

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:



916
917
918
919
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 916

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

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

Create Story Reaction Create a reaction to a story comment.

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

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



928
929
930
931
932
933
934
935
936
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 928

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Array<(Story, Integer, Hash)>

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

Parameters:

  • body —

    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



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
783
784
785
786
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 744

def create_story_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_story ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, story_public_id, opts = {}) ⇒ Task

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

Parameters:

  • body
  • story_public_id —

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

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

    the optional parameters

Returns:



985
986
987
988
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 985

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

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

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

Parameters:

  • body
  • story_public_id —

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

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

    the optional parameters

Returns:

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

    Task data, response status code and response headers



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 996

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Category.

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

    the optional parameters

Returns:

  • (nil) 


1048
1049
1050
1051
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1048

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 —

    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



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1058

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the entity template.

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

    the optional parameters

Returns:

  • (nil) 


1101
1102
1103
1104
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1101

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 —

    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



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
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1110

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

  • (nil) 


1154
1155
1156
1157
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1154

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 —

    The ID of the associated Epic.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:

  • (nil) 


1209
1210
1211
1212
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1209

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 —

    The ID of the associated Epic.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1220

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' + '}', epic_public_id.to_s).sub('{' + 'comment-public-id' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    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



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

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The File’s unique ID.

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

    the optional parameters

Returns:

  • (nil) 


1268
1269
1270
1271
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1268

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 —

    The File’s unique ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1278

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:

  • (nil) 


1321
1322
1323
1324
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1321

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 —

    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



1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1330

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Label.

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

    the optional parameters

Returns:

  • (nil) 


1374
1375
1376
1377
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1374

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 —

    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



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1384

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:

  • (nil) 


1428
1429
1430
1431
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1428

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 —

    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



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
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1438

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Milestone.

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

    the optional parameters

Returns:

  • (nil) 


1482
1483
1484
1485
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1482

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 —

    The ID of the Milestone.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1492

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ nil

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

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1536
1537
1538
1539
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1536

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1583
1584
1585
1586
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1546

def delete_multiple_stories_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_multiple_stories ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Project.

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

    the optional parameters

Returns:

  • (nil) 


1592
1593
1594
1595
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1592

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 —

    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



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

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Story.

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

    the optional parameters

Returns:

  • (nil) 


1646
1647
1648
1649
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1646

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 —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:

  • (nil) 


1701
1702
1703
1704
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1701

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 —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1712
1713
1714
1715
1716
1717
1718
1719
1720
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1712

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' + '}', story_public_id.to_s).sub('{' + 'comment-public-id' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:

  • (nil) 


1760
1761
1762
1763
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1760

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 —

    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



1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1770

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, story_public_id, comment_public_id, opts = {}) ⇒ nil

Delete Story Reaction Delete a reaction from any story comment.

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:

  • (nil) 


1816
1817
1818
1819
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1816

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

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

Delete Story Reaction Delete a reaction from any story comment.

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1828

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Story.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1656
1657
1658
1659
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1656

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

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

  • task_public_id —

    The unique ID of the Task.

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

    the optional parameters

Returns:

  • (nil) 


1883
1884
1885
1886
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1883

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 —

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

  • task_public_id —

    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



1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1894

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' + '}', story_public_id.to_s).sub('{' + 'task-public-id' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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) 


1941
1942
1943
1944
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1941

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



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1950

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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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) 


1989
1990
1991
1992
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1989

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



1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 1998

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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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) 


2037
2038
2039
2040
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2037

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



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

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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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) 


2085
2086
2087
2088
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2085

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



2094
2095
2096
2097
2098
2099
2100
2101
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2094

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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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) 


2133
2134
2135
2136
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2133

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



2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2142

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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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) 


2181
2182
2183
2184
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2181

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



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

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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Category.

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

    the optional parameters

Returns:



2230
2231
2232
2233
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2230

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 —

    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



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

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



2285
2286
2287
2288
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2285

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



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

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[:body] 

  return_type = opts[:return_type] || 'MemberInfo' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the entity template.

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

    the optional parameters

Returns:



2336
2337
2338
2339
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2336

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 —

    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



2346
2347
2348
2349
2350
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2346

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



2392
2393
2394
2395
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2392

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 —

    The ID of the associated Epic.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:



2449
2450
2451
2452
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2449

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 —

    The ID of the associated Epic.

  • comment_public_id —

    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



2460
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
2502
2503
2504
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2460

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' + '}', epic_public_id.to_s).sub('{' + 'comment-public-id' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    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



2402
2403
2404
2405
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2402

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



2509
2510
2511
2512
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2509

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



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

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[:body] 

  return_type = opts[:return_type] || 'EpicWorkflow' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Array<StorySlim>

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

Parameters:

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

    the optional parameters

Returns:



2560
2561
2562
2563
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2560

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

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



2570
2571
2572
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2570

def get_external_link_stories_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_external_link_stories ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The File’s unique ID.

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

    the optional parameters

Returns:



2618
2619
2620
2621
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2618

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 —

    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



2628
2629
2630
2631
2632
2633
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2628

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'UploadedFile' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Group.

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

    the optional parameters

Returns:



2673
2674
2675
2676
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2673

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 —

    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



2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2682

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:



2727
2728
2729
2730
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2727

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 —

    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



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2736

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Label.

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

    the optional parameters

Returns:



2782
2783
2784
2785
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2782

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 —

    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



2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2792

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:



2838
2839
2840
2841
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2838

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 —

    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



2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2848

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, member_public_id, opts = {}) ⇒ Member

Get Member Returns information about a Member.

Parameters:

  • body
  • member_public_id —

    The Member&#x27;s unique ID.

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

    the optional parameters

Returns:



2895
2896
2897
2898
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2895

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

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

Get Member Returns information about a Member.

Parameters:

  • body
  • member_public_id —

    The Member&#x27;s unique ID.

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

    the optional parameters

Returns:

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

    Member data, response status code and response headers



2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2906

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Milestone.

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

    the optional parameters

Returns:



2958
2959
2960
2961
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2958

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 —

    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



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
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 2968

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Project.

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

    the optional parameters

Returns:



3014
3015
3016
3017
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3014

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 —

    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



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
3060
3061
3062
3063
3064
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3024

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Repository.

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

    the optional parameters

Returns:



3070
3071
3072
3073
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3070

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 —

    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



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 3080

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Repository' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Story.

  • 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_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 —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:



3183
3184
3185
3186
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3183

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 —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    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



3194
3195
3196
3197
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3194

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' + '}', story_public_id.to_s).sub('{' + 'comment-public-id' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:



3244
3245
3246
3247
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3244

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 —

    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



3254
3255
3256
3257
3258
3259
3260
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3254

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    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



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

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' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

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

  • task_public_id —

    The unique ID of the Task.

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

    the optional parameters

Returns:



3301
3302
3303
3304
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3301

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 —

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

  • task_public_id —

    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



3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3312

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' + '}', story_public_id.to_s).sub('{' + 'task-public-id' + '}', 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[:body] 

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Workflow.

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

    the optional parameters

Returns:



3362
3363
3364
3365
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3362

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 —

    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



3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3372

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Workflow' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



3417
3418
3419
3420
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3417

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



3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3426

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[:body] 

  return_type = opts[:return_type] || 'Array<Category>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Category.

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

    the optional parameters

Returns:



3468
3469
3470
3471
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3468

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 —

    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



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
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3478

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Array<Milestone>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



3523
3524
3525
3526
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3523

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



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

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[:body] 

  return_type = opts[:return_type] || 'Array<EntityTemplate>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



3574
3575
3576
3577
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3574

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 —

    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



3584
3585
3586
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3584

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Array<ThreadedComment>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, epic_public_id, opts = {}) ⇒ Array<StorySlim>

List Epic Stories Get a list of all Stories in an Epic.

Parameters:

  • body
  • epic_public_id —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



3631
3632
3633
3634
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3631

def list_epic_stories(body, epic_public_id, opts = {})
  data, _status_code, _headers = list_epic_stories_with_http_info(body, epic_public_id, opts)
  data
end

#list_epic_stories_with_http_info(body, epic_public_id, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Epic Stories Get a list of all Stories in an Epic.

Parameters:

  • body
  • epic_public_id —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

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

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



3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3642

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Array<EpicSlim>

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

Parameters:

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

    the optional parameters

Returns:



3694
3695
3696
3697
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3694

def list_epics(body, opts = {})
  data, _status_code, _headers = list_epics_with_http_info(body, opts)
  data
end

#list_epics_with_http_info(body, opts = {}) ⇒ Array<(Array<EpicSlim>, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

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

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



3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3704

def list_epics_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_epics ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Array<EpicSlim>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



3751
3752
3753
3754
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3751

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



3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3760

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[:body] 

  return_type = opts[:return_type] || 'Array<UploadedFile>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, group_public_id, opts = {}) ⇒ Array<StorySlim>

List Group Stories List the Stories assigned to the Group. (By default, limited to 1,000).

Parameters:

  • body
  • group_public_id —

    The unique ID of the Group.

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

    the optional parameters

Returns:



3803
3804
3805
3806
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3803

def list_group_stories(body, group_public_id, opts = {})
  data, _status_code, _headers = list_group_stories_with_http_info(body, group_public_id, opts)
  data
end

#list_group_stories_with_http_info(body, group_public_id, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Group Stories List the Stories assigned to the Group. (By default, limited to 1,000).

Parameters:

  • body
  • group_public_id —

    The unique ID of the Group.

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

    the optional parameters

Returns:

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

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



3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3814

def list_group_stories_with_http_info(body, group_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_group_stories ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling 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
  # resource path
  local_var_path = '/api/v3/groups/{group-public-id}/stories'.sub('{' + 'group-public-id' + '}', 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



3865
3866
3867
3868
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3865

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



3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3874

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[:body] 

  return_type = opts[:return_type] || 'Array<Group>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, iteration_public_id, opts = {}) ⇒ Array<StorySlim>

List Iteration Stories Get a list of all Stories in an Iteration.

Parameters:

  • body
  • iteration_public_id —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:



3917
3918
3919
3920
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3917

def list_iteration_stories(body, iteration_public_id, opts = {})
  data, _status_code, _headers = list_iteration_stories_with_http_info(body, iteration_public_id, opts)
  data
end

#list_iteration_stories_with_http_info(body, iteration_public_id, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Iteration Stories Get a list of all Stories in an Iteration.

Parameters:

  • body
  • iteration_public_id —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:

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

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



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
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3928

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



3978
3979
3980
3981
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3978

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



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
4018
4019
4020
4021
4022
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 3986

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[:body] 

  return_type = opts[:return_type] || 'Array<IterationSlim>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Label.

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

    the optional parameters

Returns:



4028
4029
4030
4031
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4028

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 —

    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



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
4075
4076
4077
4078
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4038

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Array<EpicSlim>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, label_public_id, opts = {}) ⇒ Array<StorySlim>

List Label Stories List all of the Stories with the Label.

Parameters:

  • body
  • label_public_id —

    The unique ID of the Label.

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

    the optional parameters

Returns:



4085
4086
4087
4088
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4085

def list_label_stories(body, label_public_id, opts = {})
  data, _status_code, _headers = list_label_stories_with_http_info(body, label_public_id, opts)
  data
end

#list_label_stories_with_http_info(body, label_public_id, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Label Stories List all of the Stories with the Label.

Parameters:

  • body
  • label_public_id —

    The unique ID of the Label.

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

    the optional parameters

Returns:

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

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



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
4138
4139
4140
4141
4142
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4096

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Array<Label>

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

Parameters:

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

    the optional parameters

Returns:



4148
4149
4150
4151
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4148

def list_labels(body, opts = {})
  data, _status_code, _headers = list_labels_with_http_info(body, opts)
  data
end

#list_labels_with_http_info(body, opts = {}) ⇒ Array<(Array<Label>, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

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

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



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

def list_labels_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_labels ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Array<Label>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



4205
4206
4207
4208
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4205

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



4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4214

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[:body] 

  return_type = opts[:return_type] || 'Array<LinkedFile>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Array<Member>

List Members List Members returns information about members of the organization.

Parameters:

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

    the optional parameters

Returns:



4256
4257
4258
4259
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4256

def list_members(body, opts = {})
  data, _status_code, _headers = list_members_with_http_info(body, opts)
  data
end

#list_members_with_http_info(body, opts = {}) ⇒ Array<(Array<Member>, Integer, Hash)>

List Members List Members returns information about members of the organization.

Parameters:

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

    the optional parameters

Returns:

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

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



4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4266

def list_members_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_members ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Array<Member>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Milestone.

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

    the optional parameters

Returns:



4314
4315
4316
4317
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4314

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 —

    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



4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4324

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Array<EpicSlim>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



4369
4370
4371
4372
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4369

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



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
4411
4412
4413
4414
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4378

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[:body] 

  return_type = opts[:return_type] || 'Array<Milestone>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



4419
4420
4421
4422
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4419

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



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

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[:body] 

  return_type = opts[:return_type] || 'Array<Project>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



4469
4470
4471
4472
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4469

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



4478
4479
4480
4481
4482
4483
4484
4485
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4478

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[:body] 

  return_type = opts[:return_type] || 'Array<Repository>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, project_public_id, opts = {}) ⇒ Array<StorySlim>

List Stories List Stories returns a list of all Stories in a selected Project and their attributes.

Parameters:

  • body
  • project_public_id —

    The unique ID of the Project.

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

    the optional parameters

Returns:



4521
4522
4523
4524
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4521

def list_stories(body, project_public_id, opts = {})
  data, _status_code, _headers = list_stories_with_http_info(body, project_public_id, opts)
  data
end

#list_stories_with_http_info(body, project_public_id, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

List Stories List Stories returns a list of all Stories in a selected Project and their attributes.

Parameters:

  • body
  • project_public_id —

    The unique ID of the Project.

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

    the optional parameters

Returns:

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

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



4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4532

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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:



4583
4584
4585
4586
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4583

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



4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4592

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[:body] 

  return_type = opts[:return_type] || 'Array<Workflow>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, 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:

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

    the optional parameters

Returns:



4634
4635
4636
4637
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4634

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

#search_epics(body, 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:

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

    the optional parameters

Returns:



4692
4693
4694
4695
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4692

def search_epics(body, opts = {})
  data, _status_code, _headers = search_epics_with_http_info(body, opts)
  data
end

#search_epics_with_http_info(body, 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:

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

    the optional parameters

Returns:

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

    EpicSearchResults data, response status code and response headers



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
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4702

def search_epics_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.search_epics ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'EpicSearchResults' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, 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:

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

    the optional parameters

Returns:



4750
4751
4752
4753
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4750

def search_stories(body, opts = {})
  data, _status_code, _headers = search_stories_with_http_info(body, opts)
  data
end

#search_stories_old(body, opts = {}) ⇒ Array<StorySlim>

Search Stories (Old) Search Stories lets you search Stories based on desired parameters.

Parameters:

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

    the optional parameters

Returns:



4808
4809
4810
4811
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4808

def search_stories_old(body, opts = {})
  data, _status_code, _headers = search_stories_old_with_http_info(body, opts)
  data
end

#search_stories_old_with_http_info(body, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

Search Stories (Old) Search Stories lets you search Stories based on desired parameters.

Parameters:

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

    the optional parameters

Returns:

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

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



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
4859
4860
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4818

def search_stories_old_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.search_stories_old ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, 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:

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

    the optional parameters

Returns:

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

    StorySearchResults data, response status code and response headers



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

def search_stories_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.search_stories ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'StorySearchResults' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, 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:

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

    the optional parameters

Returns:

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

    SearchResults data, response status code and response headers



4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4644

def search_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.search ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'SearchResults' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The ID of the Story.

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

    the optional parameters

Returns:



4865
4866
4867
4868
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4865

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 —

    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



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

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' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Array<History>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 —

    The unique ID of the Epic.

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

    the optional parameters

Returns:

  • (nil) 


4920
4921
4922
4923
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4920

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 —

    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



4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4930

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' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, category_public_id, 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:

  • body
  • category_public_id —

    The unique ID of the Category you wish to update.

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

    the optional parameters

Returns:



4975
4976
4977
4978
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4975

def update_category(body, category_public_id, opts = {})
  data, _status_code, _headers = update_category_with_http_info(body, category_public_id, opts)
  data
end

#update_category_with_http_info(body, category_public_id, 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:

  • body
  • category_public_id —

    The unique ID of the Category you wish to update.

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

    the optional parameters

Returns:

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

    Category data, response status code and response headers



4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 4986

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, entity_template_public_id, opts = {}) ⇒ EntityTemplate

Update Entity Template Update an entity template’s name or its contents.

Parameters:

  • body —

    Request parameters for changing either a template&#x27;s name or any of the attributes it is designed to pre-populate.

  • entity_template_public_id —

    The unique ID of the template to be updated.

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

    the optional parameters

Returns:



5039
5040
5041
5042
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5039

def update_entity_template(body, entity_template_public_id, opts = {})
  data, _status_code, _headers = update_entity_template_with_http_info(body, entity_template_public_id, opts)
  data
end

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

Update Entity Template Update an entity template&#x27;s name or its contents.

Parameters:

  • body —

    Request parameters for changing either a template&#x27;s name or any of the attributes it is designed to pre-populate.

  • entity_template_public_id —

    The unique ID of the template to be updated.

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

    the optional parameters

Returns:

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

    EntityTemplate data, response status code and response headers



5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5050

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, epic_public_id, 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:

  • body
  • epic_public_id —

    The unique ID of the Epic.

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

    the optional parameters

Returns:



5103
5104
5105
5106
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5103

def update_epic(body, epic_public_id, opts = {})
  data, _status_code, _headers = update_epic_with_http_info(body, epic_public_id, opts)
  data
end

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

Update Epic Comment This endpoint allows you to update a threaded Comment on an Epic.

Parameters:

  • body
  • epic_public_id —

    The ID of the associated Epic.

  • comment_public_id —

    The ID of the Comment.

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

    the optional parameters

Returns:



5168
5169
5170
5171
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5168

def update_epic_comment(body, epic_public_id, comment_public_id, opts = {})
  data, _status_code, _headers = update_epic_comment_with_http_info(body, epic_public_id, comment_public_id, opts)
  data
end

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

Update Epic Comment This endpoint allows you to update a threaded Comment on an Epic.

Parameters:

  • body
  • epic_public_id —

    The ID of the associated Epic.

  • comment_public_id —

    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



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

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, epic_public_id, 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:

  • body
  • epic_public_id —

    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



5114
5115
5116
5117
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 5114

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, file_public_id, opts = {}) ⇒ UploadedFile

Update File Update File updates the properties of an UploadedFile (but not its content).

Parameters:

  • body
  • file_public_id —

    The unique ID assigned to the file in Shortcut.

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

    the optional parameters

Returns:



5237
5238
5239
5240
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5237

def update_file(body, file_public_id, opts = {})
  data, _status_code, _headers = update_file_with_http_info(body, file_public_id, opts)
  data
end

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

Update File Update File updates the properties of an UploadedFile (but not its content).

Parameters:

  • body
  • file_public_id —

    The unique ID assigned to the file in Shortcut.

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

    the optional parameters

Returns:

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

    UploadedFile data, response status code and response headers



5248
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
5292
5293
5294
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5248

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

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

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

  return_type = opts[:return_type] || 'UploadedFile' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, group_public_id, opts = {}) ⇒ Group

Update Group

Parameters:

  • body
  • group_public_id —

    The unique ID of the Group.

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

    the optional parameters

Returns:



5300
5301
5302
5303
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5300

def update_group(body, group_public_id, opts = {})
  data, _status_code, _headers = update_group_with_http_info(body, group_public_id, opts)
  data
end

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

Update Group

Parameters:

  • body
  • group_public_id —

    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



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

def update_group_with_http_info(body, group_public_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_group ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling 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
  # resource path
  local_var_path = '/api/v3/groups/{group-public-id}'.sub('{' + 'group-public-id' + '}', 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, iteration_public_id, opts = {}) ⇒ Iteration

Update Iteration

Parameters:

  • body
  • iteration_public_id —

    The unique ID of the Iteration.

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

    the optional parameters

Returns:



5362
5363
5364
5365
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5362

def update_iteration(body, iteration_public_id, opts = {})
  data, _status_code, _headers = update_iteration_with_http_info(body, iteration_public_id, opts)
  data
end

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

Update Iteration

Parameters:

  • body
  • iteration_public_id —

    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



5372
5373
5374
5375
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5372

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, label_public_id, 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:

  • body
  • label_public_id —

    The unique ID of the Label you wish to update.

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

    the optional parameters

Returns:



5425
5426
5427
5428
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5425

def update_label(body, label_public_id, opts = {})
  data, _status_code, _headers = update_label_with_http_info(body, label_public_id, opts)
  data
end

#update_label_with_http_info(body, label_public_id, 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:

  • body
  • label_public_id —

    The unique ID of the Label you wish to update.

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

    the optional parameters

Returns:

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

    Label data, response status code and response headers



5436
5437
5438
5439
5440
5441
5442
5443
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5436

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, linked_file_public_id, opts = {}) ⇒ LinkedFile

Update Linked File Updated Linked File allows you to update properties of a previously attached Linked-File.

Parameters:

  • body
  • linked_file_public_id —

    The unique identifier of the linked file.

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

    the optional parameters

Returns:



5489
5490
5491
5492
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5489

def update_linked_file(body, linked_file_public_id, opts = {})
  data, _status_code, _headers = update_linked_file_with_http_info(body, linked_file_public_id, opts)
  data
end

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

Update Linked File Updated Linked File allows you to update properties of a previously attached Linked-File.

Parameters:

  • body
  • linked_file_public_id —

    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



5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5500

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, milestone_public_id, opts = {}) ⇒ Milestone

Update Milestone Update Milestone can be used to update Milestone properties.

Parameters:

  • body
  • milestone_public_id —

    The ID of the Milestone.

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

    the optional parameters

Returns:



5553
5554
5555
5556
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5553

def update_milestone(body, milestone_public_id, opts = {})
  data, _status_code, _headers = update_milestone_with_http_info(body, milestone_public_id, opts)
  data
end

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

Update Milestone Update Milestone can be used to update Milestone properties.

Parameters:

  • body
  • milestone_public_id —

    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



5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5564

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, opts = {}) ⇒ Array<StorySlim>

Update Multiple Stories Update Multiple Stories allows you to make changes to numerous stories at once.

Parameters:

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

    the optional parameters

Returns:



5616
5617
5618
5619
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5616

def update_multiple_stories(body, opts = {})
  data, _status_code, _headers = update_multiple_stories_with_http_info(body, opts)
  data
end

#update_multiple_stories_with_http_info(body, opts = {}) ⇒ Array<(Array<StorySlim>, Integer, Hash)>

Update Multiple Stories Update Multiple Stories allows you to make changes to numerous stories at once.

Parameters:

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

    the optional parameters

Returns:

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

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



5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5626

def update_multiple_stories_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_multiple_stories ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, project_public_id, opts = {}) ⇒ Project

Update Project Update Project can be used to change properties of a Project.

Parameters:

  • body
  • project_public_id —

    The unique ID of the Project.

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

    the optional parameters

Returns:



5675
5676
5677
5678
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5675

def update_project(body, project_public_id, opts = {})
  data, _status_code, _headers = update_project_with_http_info(body, project_public_id, opts)
  data
end

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

Update Project Update Project can be used to change properties of a Project.

Parameters:

  • body
  • project_public_id —

    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



5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
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
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5686

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, story_public_id, opts = {}) ⇒ Story

Update Story Update Story can be used to update Story properties.

Parameters:

  • body
  • story_public_id —

    The unique identifier of this story.

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

    the optional parameters

Returns:



5739
5740
5741
5742
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5739

def update_story(body, story_public_id, opts = {})
  data, _status_code, _headers = update_story_with_http_info(body, story_public_id, opts)
  data
end

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

Update Story Comment Update Comment replaces the text of the existing Comment.

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    The ID of the Comment

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

    the optional parameters

Returns:



5804
5805
5806
5807
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5804

def update_story_comment(body, story_public_id, comment_public_id, opts = {})
  data, _status_code, _headers = update_story_comment_with_http_info(body, story_public_id, comment_public_id, opts)
  data
end

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

Update Story Comment Update Comment replaces the text of the existing Comment.

Parameters:

  • body
  • story_public_id —

    The ID of the Story that the Comment is in.

  • comment_public_id —

    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



5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5816

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, story_link_public_id, opts = {}) ⇒ StoryLink

Update Story Link Updates the stories and/or the relationship for the given Story Link.

Parameters:

  • body
  • story_link_public_id —

    The unique ID of the Story Link.

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

    the optional parameters

Returns:



5873
5874
5875
5876
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5873

def update_story_link(body, story_link_public_id, opts = {})
  data, _status_code, _headers = update_story_link_with_http_info(body, story_link_public_id, opts)
  data
end

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

Update Story Link Updates the stories and/or the relationship for the given Story Link.

Parameters:

  • body
  • story_link_public_id —

    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



5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5884

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, story_public_id, opts = {}) ⇒ Array<(Story, Integer, Hash)>

Update Story Update Story can be used to update Story properties.

Parameters:

  • body
  • story_public_id —

    The unique identifier of this story.

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

    the optional parameters

Returns:

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

    Story data, response status code and response headers



5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5750

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(body, story_public_id, task_public_id, opts = {}) ⇒ Task

Update Task Update Task can be used to update Task properties.

Parameters:

  • body
  • story_public_id —

    The unique identifier of the parent Story.

  • task_public_id —

    The unique identifier of the Task you wish to update.

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

    the optional parameters

Returns:



5938
5939
5940
5941
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5938

def update_task(body, story_public_id, task_public_id, opts = {})
  data, _status_code, _headers = update_task_with_http_info(body, story_public_id, task_public_id, opts)
  data
end

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

Update Task Update Task can be used to update Task properties.

Parameters:

  • body
  • story_public_id —

    The unique identifier of the parent Story.

  • task_public_id —

    The unique identifier of the Task you wish to update.

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

    the optional parameters

Returns:

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

    Task data, response status code and response headers



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
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 5950

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

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

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

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

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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(story_id, file0, file1, file2, file3, 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:

  • story_id
  • file0
  • file1
  • file2
  • file3
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6010
6011
6012
6013
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6010

def upload_files(story_id, file0, file1, file2, file3, opts = {})
  data, _status_code, _headers = upload_files_with_http_info(story_id, file0, file1, file2, file3, opts)
  data
end

#upload_files_with_http_info(story_id, file0, file1, file2, file3, 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&#x27;s name comes from the Content-Disposition header &quot;filename&quot; directive for that field.

Parameters:

  • story_id
  • file0
  • file1
  • file2
  • file3
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

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



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
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
 
# File 'lib/shortcut_client_ruby/api/default_api.rb', line 6024

def upload_files_with_http_info(story_id, file0, file1, file2, file3, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.upload_files ...'
  end
  # verify the required parameter 'story_id' is set
  if @api_client.config.client_side_validation && story_id.nil?
    fail ArgumentError, "Missing the required parameter 'story_id' when calling 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
  # verify the required parameter 'file1' is set
  if @api_client.config.client_side_validation && file1.nil?
    fail ArgumentError, "Missing the required parameter 'file1' when calling DefaultApi.upload_files"
  end
  # verify the required parameter 'file2' is set
  if @api_client.config.client_side_validation && file2.nil?
    fail ArgumentError, "Missing the required parameter 'file2' when calling DefaultApi.upload_files"
  end
  # verify the required parameter 'file3' is set
  if @api_client.config.client_side_validation && file3.nil?
    fail ArgumentError, "Missing the required parameter 'file3' 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['story_id'] = story_id
  form_params['file0'] = file0
  form_params['file1'] = file1
  form_params['file2'] = file2
  form_params['file3'] = file3

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

  return_type = opts[:return_type] || 'Array<UploadedFile>' 

  auth_names = opts[:auth_names] || ['api_token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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