Class: Shortcut::Story

Inherits:
Object
  • Object
show all
Defined in:
lib/shortcut_client_ruby/models/story.rb

Overview

Stories are the standard unit of work in Shortcut and represent individual features, bugs, and chores.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Story

Initializes the object

Parameters:

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

    Model attributes in the form of hash



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
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
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 307

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::Story` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Shortcut::Story`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'app_url')
    self.app_url = attributes[:'app_url']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'archived')
    self.archived = attributes[:'archived']
  end

  if attributes.key?(:'started')
    self.started = attributes[:'started']
  end

  if attributes.key?(:'story_links')
    if (value = attributes[:'story_links']).is_a?(Array)
      self.story_links = value
    end
  end

  if attributes.key?(:'entity_type')
    self.entity_type = attributes[:'entity_type']
  end

  if attributes.key?(:'labels')
    if (value = attributes[:'labels']).is_a?(Array)
      self.labels = value
    end
  end

  if attributes.key?(:'mention_ids')
    if (value = attributes[:'mention_ids']).is_a?(Array)
      self.mention_ids = value
    end
  end

  if attributes.key?(:'member_mention_ids')
    if (value = attributes[:'member_mention_ids']).is_a?(Array)
      self.member_mention_ids = value
    end
  end

  if attributes.key?(:'story_type')
    self.story_type = attributes[:'story_type']
  end

  if attributes.key?(:'linked_files')
    if (value = attributes[:'linked_files']).is_a?(Array)
      self.linked_files = value
    end
  end

  if attributes.key?(:'workflow_id')
    self.workflow_id = attributes[:'workflow_id']
  end

  if attributes.key?(:'completed_at_override')
    self.completed_at_override = attributes[:'completed_at_override']
  end

  if attributes.key?(:'started_at')
    self.started_at = attributes[:'started_at']
  end

  if attributes.key?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'completed')
    self.completed = attributes[:'completed']
  end

  if attributes.key?(:'comments')
    if (value = attributes[:'comments']).is_a?(Array)
      self.comments = value
    end
  end

  if attributes.key?(:'blocker')
    self.blocker = attributes[:'blocker']
  end

  if attributes.key?(:'branches')
    if (value = attributes[:'branches']).is_a?(Array)
      self.branches = value
    end
  end

  if attributes.key?(:'epic_id')
    self.epic_id = attributes[:'epic_id']
  end

  if attributes.key?(:'story_template_id')
    self.story_template_id = attributes[:'story_template_id']
  end

  if attributes.key?(:'external_links')
    if (value = attributes[:'external_links']).is_a?(Array)
      self.external_links = value
    end
  end

  if attributes.key?(:'previous_iteration_ids')
    if (value = attributes[:'previous_iteration_ids']).is_a?(Array)
      self.previous_iteration_ids = value
    end
  end

  if attributes.key?(:'requested_by_id')
    self.requested_by_id = attributes[:'requested_by_id']
  end

  if attributes.key?(:'iteration_id')
    self.iteration_id = attributes[:'iteration_id']
  end

  if attributes.key?(:'tasks')
    if (value = attributes[:'tasks']).is_a?(Array)
      self.tasks = value
    end
  end

  if attributes.key?(:'label_ids')
    if (value = attributes[:'label_ids']).is_a?(Array)
      self.label_ids = value
    end
  end

  if attributes.key?(:'started_at_override')
    self.started_at_override = attributes[:'started_at_override']
  end

  if attributes.key?(:'group_id')
    self.group_id = attributes[:'group_id']
  end

  if attributes.key?(:'workflow_state_id')
    self.workflow_state_id = attributes[:'workflow_state_id']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.key?(:'pull_requests')
    if (value = attributes[:'pull_requests']).is_a?(Array)
      self.pull_requests = value
    end
  end

  if attributes.key?(:'group_mention_ids')
    if (value = attributes[:'group_mention_ids']).is_a?(Array)
      self.group_mention_ids = value
    end
  end

  if attributes.key?(:'follower_ids')
    if (value = attributes[:'follower_ids']).is_a?(Array)
      self.follower_ids = value
    end
  end

  if attributes.key?(:'owner_ids')
    if (value = attributes[:'owner_ids']).is_a?(Array)
      self.owner_ids = value
    end
  end

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'lead_time')
    self.lead_time = attributes[:'lead_time']
  end

  if attributes.key?(:'estimate')
    self.estimate = attributes[:'estimate']
  end

  if attributes.key?(:'commits')
    if (value = attributes[:'commits']).is_a?(Array)
      self.commits = value
    end
  end

  if attributes.key?(:'files')
    if (value = attributes[:'files']).is_a?(Array)
      self.files = value
    end
  end

  if attributes.key?(:'position')
    self.position = attributes[:'position']
  end

  if attributes.key?(:'blocked')
    self.blocked = attributes[:'blocked']
  end

  if attributes.key?(:'project_id')
    self.project_id = attributes[:'project_id']
  end

  if attributes.key?(:'deadline')
    self.deadline = attributes[:'deadline']
  end

  if attributes.key?(:'stats')
    self.stats = attributes[:'stats']
  end

  if attributes.key?(:'cycle_time')
    self.cycle_time = attributes[:'cycle_time']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'moved_at')
    self.moved_at = attributes[:'moved_at']
  end
end

Instance Attribute Details

#app_url ⇒ Object

The Shortcut application url for the Story.



20
21
22
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 20

def app_url
  @app_url
end

#archived ⇒ Object

True if the story has been archived or not.



26
27
28
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 26

def archived
  @archived
end

#blocked ⇒ Object

A true/false boolean indicating if the Story is currently blocked.



149
150
151
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 149

def blocked
  @blocked
end

#blocker ⇒ Object

A true/false boolean indicating if the Story is currently a blocker of another story.



74
75
76
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 74

def blocker
  @blocker
end

#branches ⇒ Object

An array of Git branches attached to the story.



77
78
79
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 77

def branches
  @branches
end

#comments ⇒ Object

An array of comments attached to the story.



71
72
73
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 71

def comments
  @comments
end

#commits ⇒ Object

An array of commits attached to the story.



140
141
142
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 140

def commits
  @commits
end

#completed ⇒ Object

A true/false boolean indicating if the Story has been completed.



68
69
70
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 68

def completed
  @completed
end

#completed_at ⇒ Object

The time/date the Story was completed.



62
63
64
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 62

def completed_at
  @completed_at
end

#completed_at_override ⇒ Object

A manual override for the time/date the Story was completed.



56
57
58
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 56

def completed_at_override
  @completed_at_override
end

#created_at ⇒ Object

The time/date the Story was created.



163
164
165
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 163

def created_at
  @created_at
end

#cycle_time ⇒ Object

The cycle time (in seconds) of this story when complete.



160
161
162
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 160

def cycle_time
  @cycle_time
end

#deadline ⇒ Object

The due date of the story.



155
156
157
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 155

def deadline
  @deadline
end

#description ⇒ Object

The description of the story.



23
24
25
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 23

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



35
36
37
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 35

def entity_type
  @entity_type
end

#epic_id ⇒ Object

The ID of the epic the story belongs to.



80
81
82
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 80

def epic_id
  @epic_id
end

#estimate ⇒ Object

The numeric point estimate of the story. Can also be null, which means unestimated.



137
138
139
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 137

def estimate
  @estimate
end

#external_id ⇒ Object

This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.



128
129
130
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 128

def external_id
  @external_id
end

#external_links ⇒ Object

An array of external links (strings) associated with a Story



86
87
88
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 86

def external_links
  @external_links
end

#files ⇒ Object

An array of files attached to the story.



143
144
145
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 143

def files
  @files
end

#follower_ids ⇒ Object

An array of UUIDs for any Members listed as Followers.



122
123
124
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 122

def follower_ids
  @follower_ids
end

#group_id ⇒ Object

The ID of the group associated with the story.



107
108
109
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 107

def group_id
  @group_id
end

#group_mention_ids ⇒ Object

An array of Group IDs that have been mentioned in the Story description.



119
120
121
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 119

def group_mention_ids
  @group_mention_ids
end

#id ⇒ Object

The unique ID of the Story.



131
132
133
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 131

def id
  @id
end

#iteration_id ⇒ Object

The ID of the iteration the story belongs to.



95
96
97
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 95

def iteration_id
  @iteration_id
end

#label_ids ⇒ Object

An array of label ids attached to the story.



101
102
103
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 101

def label_ids
  @label_ids
end

#labels ⇒ Object

An array of labels attached to the story.



38
39
40
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 38

def labels
  @labels
end

#lead_time ⇒ Object

The lead time (in seconds) of this story when complete.



134
135
136
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 134

def lead_time
  @lead_time
end

#linked_files ⇒ Object

An array of linked files attached to the story.



50
51
52
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 50

def linked_files
  @linked_files
end

#member_mention_ids ⇒ Object

An array of Member IDs that have been mentioned in the Story description.



44
45
46
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 44

def member_mention_ids
  @member_mention_ids
end

#mention_ids ⇒ Object

Deprecated: use member_mention_ids.



41
42
43
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 41

def mention_ids
  @mention_ids
end

#moved_at ⇒ Object

The time/date the Story was last changed workflow-state.



166
167
168
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 166

def moved_at
  @moved_at
end

#name ⇒ Object

The name of the story.



65
66
67
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 65

def name
  @name
end

#owner_ids ⇒ Object

An array of UUIDs of the owners of this story.



125
126
127
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 125

def owner_ids
  @owner_ids
end

#position ⇒ Object

A number representing the position of the story in relation to every other story in the current project.



146
147
148
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 146

def position
  @position
end

#previous_iteration_ids ⇒ Object

The IDs of the iteration the story belongs to.



89
90
91
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 89

def previous_iteration_ids
  @previous_iteration_ids
end

#project_id ⇒ Object

The ID of the project the story belongs to.



152
153
154
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 152

def project_id
  @project_id
end

#pull_requests ⇒ Object

An array of Pull/Merge Requests attached to the story.



116
117
118
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 116

def pull_requests
  @pull_requests
end

#requested_by_id ⇒ Object

The ID of the Member that requested the story.



92
93
94
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 92

def requested_by_id
  @requested_by_id
end

#started ⇒ Object

A true/false boolean indicating if the Story has been started.



29
30
31
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 29

def started
  @started
end

#started_at ⇒ Object

The time/date the Story was started.



59
60
61
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 59

def started_at
  @started_at
end

#started_at_override ⇒ Object

A manual override for the time/date the Story was started.



104
105
106
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 104

def started_at_override
  @started_at_override
end

#stats ⇒ Object

Returns the value of attribute stats.



157
158
159
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 157

def stats
  @stats
end

#story_links ⇒ Object

An array of story links attached to the Story.



32
33
34
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 32

def story_links
  @story_links
end

#story_template_id ⇒ Object

The ID of the story template used to create this story, or null if not created using a template.



83
84
85
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 83

def story_template_id
  @story_template_id
end

#story_type ⇒ Object

The type of story (feature, bug, chore).



47
48
49
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 47

def story_type
  @story_type
end

#tasks ⇒ Object

An array of tasks connected to the story.



98
99
100
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 98

def tasks
  @tasks
end

#updated_at ⇒ Object

The time/date the Story was updated.



113
114
115
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 113

def updated_at
  @updated_at
end

#workflow_id ⇒ Object

The ID of the workflow the story belongs to.



53
54
55
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 53

def workflow_id
  @workflow_id
end

#workflow_state_id ⇒ Object

The ID of the workflow state the story is currently in.



110
111
112
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 110

def workflow_state_id
  @workflow_state_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



225
226
227
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 225

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 169

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'archived' => :'archived',
    :'started' => :'started',
    :'story_links' => :'story_links',
    :'entity_type' => :'entity_type',
    :'labels' => :'labels',
    :'mention_ids' => :'mention_ids',
    :'member_mention_ids' => :'member_mention_ids',
    :'story_type' => :'story_type',
    :'linked_files' => :'linked_files',
    :'workflow_id' => :'workflow_id',
    :'completed_at_override' => :'completed_at_override',
    :'started_at' => :'started_at',
    :'completed_at' => :'completed_at',
    :'name' => :'name',
    :'completed' => :'completed',
    :'comments' => :'comments',
    :'blocker' => :'blocker',
    :'branches' => :'branches',
    :'epic_id' => :'epic_id',
    :'story_template_id' => :'story_template_id',
    :'external_links' => :'external_links',
    :'previous_iteration_ids' => :'previous_iteration_ids',
    :'requested_by_id' => :'requested_by_id',
    :'iteration_id' => :'iteration_id',
    :'tasks' => :'tasks',
    :'label_ids' => :'label_ids',
    :'started_at_override' => :'started_at_override',
    :'group_id' => :'group_id',
    :'workflow_state_id' => :'workflow_state_id',
    :'updated_at' => :'updated_at',
    :'pull_requests' => :'pull_requests',
    :'group_mention_ids' => :'group_mention_ids',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'lead_time' => :'lead_time',
    :'estimate' => :'estimate',
    :'commits' => :'commits',
    :'files' => :'files',
    :'position' => :'position',
    :'blocked' => :'blocked',
    :'project_id' => :'project_id',
    :'deadline' => :'deadline',
    :'stats' => :'stats',
    :'cycle_time' => :'cycle_time',
    :'created_at' => :'created_at',
    :'moved_at' => :'moved_at'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



810
811
812
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 810

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 286

def self.openapi_nullable
  Set.new([
    :'completed_at_override',
    :'started_at',
    :'completed_at',
    :'epic_id',
    :'story_template_id',
    :'iteration_id',
    :'started_at_override',
    :'group_id',
    :'updated_at',
    :'external_id',
    :'estimate',
    :'project_id',
    :'deadline',
    :'moved_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 230

def self.openapi_types
  {
    :'app_url' => :'String',
    :'description' => :'String',
    :'archived' => :'Boolean',
    :'started' => :'Boolean',
    :'story_links' => :'Array<TypedStoryLink>',
    :'entity_type' => :'String',
    :'labels' => :'Array<LabelSlim>',
    :'mention_ids' => :'Array<String>',
    :'member_mention_ids' => :'Array<String>',
    :'story_type' => :'String',
    :'linked_files' => :'Array<LinkedFile>',
    :'workflow_id' => :'Integer',
    :'completed_at_override' => :'Time',
    :'started_at' => :'Time',
    :'completed_at' => :'Time',
    :'name' => :'String',
    :'completed' => :'Boolean',
    :'comments' => :'Array<StoryComment>',
    :'blocker' => :'Boolean',
    :'branches' => :'Array<Branch>',
    :'epic_id' => :'Integer',
    :'story_template_id' => :'String',
    :'external_links' => :'Array<String>',
    :'previous_iteration_ids' => :'Array<Integer>',
    :'requested_by_id' => :'String',
    :'iteration_id' => :'Integer',
    :'tasks' => :'Array<Task>',
    :'label_ids' => :'Array<Integer>',
    :'started_at_override' => :'Time',
    :'group_id' => :'String',
    :'workflow_state_id' => :'Integer',
    :'updated_at' => :'Time',
    :'pull_requests' => :'Array<PullRequest>',
    :'group_mention_ids' => :'Array<String>',
    :'follower_ids' => :'Array<String>',
    :'owner_ids' => :'Array<String>',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'lead_time' => :'Integer',
    :'estimate' => :'Integer',
    :'commits' => :'Array<Commit>',
    :'files' => :'Array<UploadedFile>',
    :'position' => :'Integer',
    :'blocked' => :'Boolean',
    :'project_id' => :'Integer',
    :'deadline' => :'Time',
    :'stats' => :'StoryStats',
    :'cycle_time' => :'Integer',
    :'created_at' => :'Time',
    :'moved_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 740

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      description == o.description &&
      archived == o.archived &&
      started == o.started &&
      story_links == o.story_links &&
      entity_type == o.entity_type &&
      labels == o.labels &&
      mention_ids == o.mention_ids &&
      member_mention_ids == o.member_mention_ids &&
      story_type == o.story_type &&
      linked_files == o.linked_files &&
      workflow_id == o.workflow_id &&
      completed_at_override == o.completed_at_override &&
      started_at == o.started_at &&
      completed_at == o.completed_at &&
      name == o.name &&
      completed == o.completed &&
      comments == o.comments &&
      blocker == o.blocker &&
      branches == o.branches &&
      epic_id == o.epic_id &&
      story_template_id == o.story_template_id &&
      external_links == o.external_links &&
      previous_iteration_ids == o.previous_iteration_ids &&
      requested_by_id == o.requested_by_id &&
      iteration_id == o.iteration_id &&
      tasks == o.tasks &&
      label_ids == o.label_ids &&
      started_at_override == o.started_at_override &&
      group_id == o.group_id &&
      workflow_state_id == o.workflow_state_id &&
      updated_at == o.updated_at &&
      pull_requests == o.pull_requests &&
      group_mention_ids == o.group_mention_ids &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      external_id == o.external_id &&
      id == o.id &&
      lead_time == o.lead_time &&
      estimate == o.estimate &&
      commits == o.commits &&
      files == o.files &&
      position == o.position &&
      blocked == o.blocked &&
      project_id == o.project_id &&
      deadline == o.deadline &&
      stats == o.stats &&
      cycle_time == o.cycle_time &&
      created_at == o.created_at &&
      moved_at == o.moved_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 841

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Shortcut.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 912

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 817

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


797
798
799
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 797

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



803
804
805
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 803

def hash
  [app_url, description, archived, started, story_links, entity_type, labels, mention_ids, member_mention_ids, story_type, linked_files, workflow_id, completed_at_override, started_at, completed_at, name, completed, comments, blocker, branches, epic_id, story_template_id, external_links, previous_iteration_ids, requested_by_id, iteration_id, tasks, label_ids, started_at_override, group_id, workflow_state_id, updated_at, pull_requests, group_mention_ids, follower_ids, owner_ids, external_id, id, lead_time, estimate, commits, files, position, blocked, project_id, deadline, stats, cycle_time, created_at, moved_at].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



557
558
559
560
561
562
563
564
565
566
567
568
569
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
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 557

def list_invalid_properties
  invalid_properties = Array.new
  if @app_url.nil?
    invalid_properties.push('invalid value for "app_url", app_url cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @archived.nil?
    invalid_properties.push('invalid value for "archived", archived cannot be nil.')
  end

  if @started.nil?
    invalid_properties.push('invalid value for "started", started cannot be nil.')
  end

  if @story_links.nil?
    invalid_properties.push('invalid value for "story_links", story_links cannot be nil.')
  end

  if @entity_type.nil?
    invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
  end

  if @labels.nil?
    invalid_properties.push('invalid value for "labels", labels cannot be nil.')
  end

  if @mention_ids.nil?
    invalid_properties.push('invalid value for "mention_ids", mention_ids cannot be nil.')
  end

  if @member_mention_ids.nil?
    invalid_properties.push('invalid value for "member_mention_ids", member_mention_ids cannot be nil.')
  end

  if @story_type.nil?
    invalid_properties.push('invalid value for "story_type", story_type cannot be nil.')
  end

  if @linked_files.nil?
    invalid_properties.push('invalid value for "linked_files", linked_files cannot be nil.')
  end

  if @workflow_id.nil?
    invalid_properties.push('invalid value for "workflow_id", workflow_id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @completed.nil?
    invalid_properties.push('invalid value for "completed", completed cannot be nil.')
  end

  if @comments.nil?
    invalid_properties.push('invalid value for "comments", comments cannot be nil.')
  end

  if @blocker.nil?
    invalid_properties.push('invalid value for "blocker", blocker cannot be nil.')
  end

  if @branches.nil?
    invalid_properties.push('invalid value for "branches", branches cannot be nil.')
  end

  if @external_links.nil?
    invalid_properties.push('invalid value for "external_links", external_links cannot be nil.')
  end

  if @previous_iteration_ids.nil?
    invalid_properties.push('invalid value for "previous_iteration_ids", previous_iteration_ids cannot be nil.')
  end

  if @requested_by_id.nil?
    invalid_properties.push('invalid value for "requested_by_id", requested_by_id cannot be nil.')
  end

  if @tasks.nil?
    invalid_properties.push('invalid value for "tasks", tasks cannot be nil.')
  end

  if @label_ids.nil?
    invalid_properties.push('invalid value for "label_ids", label_ids cannot be nil.')
  end

  if @workflow_state_id.nil?
    invalid_properties.push('invalid value for "workflow_state_id", workflow_state_id cannot be nil.')
  end

  if @pull_requests.nil?
    invalid_properties.push('invalid value for "pull_requests", pull_requests cannot be nil.')
  end

  if @group_mention_ids.nil?
    invalid_properties.push('invalid value for "group_mention_ids", group_mention_ids cannot be nil.')
  end

  if @follower_ids.nil?
    invalid_properties.push('invalid value for "follower_ids", follower_ids cannot be nil.')
  end

  if @owner_ids.nil?
    invalid_properties.push('invalid value for "owner_ids", owner_ids cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @commits.nil?
    invalid_properties.push('invalid value for "commits", commits cannot be nil.')
  end

  if @files.nil?
    invalid_properties.push('invalid value for "files", files cannot be nil.')
  end

  if @position.nil?
    invalid_properties.push('invalid value for "position", position cannot be nil.')
  end

  if @blocked.nil?
    invalid_properties.push('invalid value for "blocked", blocked cannot be nil.')
  end

  if @stats.nil?
    invalid_properties.push('invalid value for "stats", stats cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



888
889
890
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 888

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 894

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



882
883
884
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 882

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



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
729
730
731
732
733
734
735
736
 
# File 'lib/shortcut_client_ruby/models/story.rb', line 700

def valid?
  return false if @app_url.nil?
  return false if @description.nil?
  return false if @archived.nil?
  return false if @started.nil?
  return false if @story_links.nil?
  return false if @entity_type.nil?
  return false if @labels.nil?
  return false if @mention_ids.nil?
  return false if @member_mention_ids.nil?
  return false if @story_type.nil?
  return false if @linked_files.nil?
  return false if @workflow_id.nil?
  return false if @name.nil?
  return false if @completed.nil?
  return false if @comments.nil?
  return false if @blocker.nil?
  return false if @branches.nil?
  return false if @external_links.nil?
  return false if @previous_iteration_ids.nil?
  return false if @requested_by_id.nil?
  return false if @tasks.nil?
  return false if @label_ids.nil?
  return false if @workflow_state_id.nil?
  return false if @pull_requests.nil?
  return false if @group_mention_ids.nil?
  return false if @follower_ids.nil?
  return false if @owner_ids.nil?
  return false if @id.nil?
  return false if @commits.nil?
  return false if @files.nil?
  return false if @position.nil?
  return false if @blocked.nil?
  return false if @stats.nil?
  return false if @created_at.nil?
  true
end