Class: Shortcut::Epic

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

Overview

An Epic is a collection of stories that together might make up a release, a milestone, or some other large initiative that your organization is working on.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Epic

Initializes the object

Parameters:

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

    Model attributes in the form of hash



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
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
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 247

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::Epic` 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::Epic`. 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?(:'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?(:'project_ids')
    if (value = attributes[:'project_ids']).is_a?(Array)
      self.project_ids = value
    end
  end

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

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

  if attributes.key?(:'productboard_plugin_id')
    self.productboard_plugin_id = attributes[:'productboard_plugin_id']
  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?(:'productboard_url')
    self.productboard_url = attributes[:'productboard_url']
  end

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

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

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

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

  if attributes.key?(:'epic_state_id')
    self.epic_state_id = attributes[:'epic_state_id']
  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?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  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?(:'productboard_id')
    self.productboard_id = attributes[:'productboard_id']
  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?(:'position')
    self.position = attributes[:'position']
  end

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

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

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

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

Instance Attribute Details

#app_url ⇒ Object

The Shortcut application url for the Epic.



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

def app_url
  @app_url
end

#archived ⇒ Object

True/false boolean that indicates whether the Epic is archived or not.



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

def archived
  @archived
end

#comments ⇒ Object

A nested array of threaded comments.



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

def comments
  @comments
end

#completed ⇒ Object

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



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

def completed
  @completed
end

#completed_at ⇒ Object

The time/date the Epic was completed.



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

def completed_at
  @completed_at
end

#completed_at_override ⇒ Object

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



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

def completed_at_override
  @completed_at_override
end

#created_at ⇒ Object

The time/date the Epic was created.



129
130
131
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 129

def created_at
  @created_at
end

#deadline ⇒ Object

The Epic’s deadline.



124
125
126
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 124

def deadline
  @deadline
end

#description ⇒ Object

The Epic’s description.



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

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



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

def entity_type
  @entity_type
end

#epic_state_id ⇒ Object

The ID of the Epic State.



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

def epic_state_id
  @epic_state_id
end

#external_id ⇒ Object

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



112
113
114
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 112

def external_id
  @external_id
end

#follower_ids ⇒ Object

An array of UUIDs for any Members you want to add as Followers on this Epic.



106
107
108
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 106

def follower_ids
  @follower_ids
end

#group_id ⇒ Object

Returns the value of attribute group_id.



94
95
96
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 94

def group_id
  @group_id
end

#group_mention_ids ⇒ Object

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



100
101
102
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 100

def group_mention_ids
  @group_mention_ids
end

#id ⇒ Object

The unique ID of the Epic.



115
116
117
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 115

def id
  @id
end

#label_ids ⇒ Object

An array of Label ids attached to the Epic.



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

def label_ids
  @label_ids
end

#labels ⇒ Object

An array of Labels attached to the Epic.



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

def labels
  @labels
end

#member_mention_ids ⇒ Object

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



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

def member_mention_ids
  @member_mention_ids
end

#mention_ids ⇒ Object

Deprecated: use member_mention_ids.



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

def mention_ids
  @mention_ids
end

#milestone_id ⇒ Object

The ID of the Milestone this Epic is related to.



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

def milestone_id
  @milestone_id
end

#name ⇒ Object

The name of the Epic.



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

def name
  @name
end

#owner_ids ⇒ Object

An array of UUIDs for any members you want to add as Owners on this new Epic.



109
110
111
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 109

def owner_ids
  @owner_ids
end

#planned_start_date ⇒ Object

The Epic’s planned start date.



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

def planned_start_date
  @planned_start_date
end

#position ⇒ Object

The Epic’s relative position in the Epic workflow state.



118
119
120
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 118

def position
  @position
end

#productboard_id ⇒ Object

The ID of the associated productboard feature.



103
104
105
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 103

def productboard_id
  @productboard_id
end

#productboard_name ⇒ Object

The name of the associated productboard feature.



121
122
123
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 121

def productboard_name
  @productboard_name
end

#productboard_plugin_id ⇒ Object

The ID of the associated productboard integration.



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

def productboard_plugin_id
  @productboard_plugin_id
end

#productboard_url ⇒ Object

The URL of the associated productboard feature.



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

def productboard_url
  @productboard_url
end

#project_ids ⇒ Object

The IDs of Projects related to this Epic.



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

def project_ids
  @project_ids
end

#requested_by_id ⇒ Object

The ID of the Member that requested the epic.



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

def requested_by_id
  @requested_by_id
end

#started ⇒ Object

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



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

def started
  @started
end

#started_at ⇒ Object

The time/date the Epic was started.



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

def started_at
  @started_at
end

#started_at_override ⇒ Object

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



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

def started_at_override
  @started_at_override
end

#state ⇒ Object

‘Deprecated` The workflow state that the Epic is in.



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

def state
  @state
end

#stats ⇒ Object

Returns the value of attribute stats.



126
127
128
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 126

def stats
  @stats
end

#stories_without_projects ⇒ Object

The number of stories in this epic which are not associated with a project.



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

def stories_without_projects
  @stories_without_projects
end

#updated_at ⇒ Object

The time/date the Epic was updated.



97
98
99
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 97

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



176
177
178
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 176

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 132

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'archived' => :'archived',
    :'started' => :'started',
    :'entity_type' => :'entity_type',
    :'labels' => :'labels',
    :'mention_ids' => :'mention_ids',
    :'member_mention_ids' => :'member_mention_ids',
    :'project_ids' => :'project_ids',
    :'stories_without_projects' => :'stories_without_projects',
    :'completed_at_override' => :'completed_at_override',
    :'productboard_plugin_id' => :'productboard_plugin_id',
    :'started_at' => :'started_at',
    :'completed_at' => :'completed_at',
    :'name' => :'name',
    :'completed' => :'completed',
    :'comments' => :'comments',
    :'productboard_url' => :'productboard_url',
    :'planned_start_date' => :'planned_start_date',
    :'state' => :'state',
    :'milestone_id' => :'milestone_id',
    :'requested_by_id' => :'requested_by_id',
    :'epic_state_id' => :'epic_state_id',
    :'label_ids' => :'label_ids',
    :'started_at_override' => :'started_at_override',
    :'group_id' => :'group_id',
    :'updated_at' => :'updated_at',
    :'group_mention_ids' => :'group_mention_ids',
    :'productboard_id' => :'productboard_id',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'position' => :'position',
    :'productboard_name' => :'productboard_name',
    :'deadline' => :'deadline',
    :'stats' => :'stats',
    :'created_at' => :'created_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



619
620
621
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 619

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 225

def self.openapi_nullable
  Set.new([
    :'completed_at_override',
    :'productboard_plugin_id',
    :'started_at',
    :'completed_at',
    :'productboard_url',
    :'planned_start_date',
    :'milestone_id',
    :'started_at_override',
    :'group_id',
    :'updated_at',
    :'productboard_id',
    :'external_id',
    :'productboard_name',
    :'deadline',
    :'created_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/epic.rb', line 181

def self.openapi_types
  {
    :'app_url' => :'String',
    :'description' => :'String',
    :'archived' => :'Boolean',
    :'started' => :'Boolean',
    :'entity_type' => :'String',
    :'labels' => :'Array<LabelSlim>',
    :'mention_ids' => :'Array<String>',
    :'member_mention_ids' => :'Array<String>',
    :'project_ids' => :'Array<Integer>',
    :'stories_without_projects' => :'Integer',
    :'completed_at_override' => :'Time',
    :'productboard_plugin_id' => :'String',
    :'started_at' => :'Time',
    :'completed_at' => :'Time',
    :'name' => :'String',
    :'completed' => :'Boolean',
    :'comments' => :'Array<ThreadedComment>',
    :'productboard_url' => :'String',
    :'planned_start_date' => :'Time',
    :'state' => :'String',
    :'milestone_id' => :'Integer',
    :'requested_by_id' => :'String',
    :'epic_state_id' => :'Integer',
    :'label_ids' => :'Array<Integer>',
    :'started_at_override' => :'Time',
    :'group_id' => :'String',
    :'updated_at' => :'Time',
    :'group_mention_ids' => :'Array<String>',
    :'productboard_id' => :'String',
    :'follower_ids' => :'Array<String>',
    :'owner_ids' => :'Array<String>',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'position' => :'Integer',
    :'productboard_name' => :'String',
    :'deadline' => :'Time',
    :'stats' => :'EpicStats',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 561

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 &&
      entity_type == o.entity_type &&
      labels == o.labels &&
      mention_ids == o.mention_ids &&
      member_mention_ids == o.member_mention_ids &&
      project_ids == o.project_ids &&
      stories_without_projects == o.stories_without_projects &&
      completed_at_override == o.completed_at_override &&
      productboard_plugin_id == o.productboard_plugin_id &&
      started_at == o.started_at &&
      completed_at == o.completed_at &&
      name == o.name &&
      completed == o.completed &&
      comments == o.comments &&
      productboard_url == o.productboard_url &&
      planned_start_date == o.planned_start_date &&
      state == o.state &&
      milestone_id == o.milestone_id &&
      requested_by_id == o.requested_by_id &&
      epic_state_id == o.epic_state_id &&
      label_ids == o.label_ids &&
      started_at_override == o.started_at_override &&
      group_id == o.group_id &&
      updated_at == o.updated_at &&
      group_mention_ids == o.group_mention_ids &&
      productboard_id == o.productboard_id &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      external_id == o.external_id &&
      id == o.id &&
      position == o.position &&
      productboard_name == o.productboard_name &&
      deadline == o.deadline &&
      stats == o.stats &&
      created_at == o.created_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



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
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 650

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



721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 721

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



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 626

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


606
607
608
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 606

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



612
613
614
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 612

def hash
  [app_url, description, archived, started, entity_type, labels, mention_ids, member_mention_ids, project_ids, stories_without_projects, completed_at_override, productboard_plugin_id, started_at, completed_at, name, completed, comments, productboard_url, planned_start_date, state, milestone_id, requested_by_id, epic_state_id, label_ids, started_at_override, group_id, updated_at, group_mention_ids, productboard_id, follower_ids, owner_ids, external_id, id, position, productboard_name, deadline, stats, created_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



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
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 433

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 @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 @project_ids.nil?
    invalid_properties.push('invalid value for "project_ids", project_ids cannot be nil.')
  end

  if @stories_without_projects.nil?
    invalid_properties.push('invalid value for "stories_without_projects", stories_without_projects 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 @state.nil?
    invalid_properties.push('invalid value for "state", state 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 @epic_state_id.nil?
    invalid_properties.push('invalid value for "epic_state_id", epic_state_id cannot be nil.')
  end

  if @label_ids.nil?
    invalid_properties.push('invalid value for "label_ids", label_ids 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 @position.nil?
    invalid_properties.push('invalid value for "position", position cannot be nil.')
  end

  if @stats.nil?
    invalid_properties.push('invalid value for "stats", stats 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



697
698
699
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 697

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



703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 703

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



691
692
693
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 691

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



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/shortcut_client_ruby/models/epic.rb', line 532

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 @entity_type.nil?
  return false if @labels.nil?
  return false if @mention_ids.nil?
  return false if @member_mention_ids.nil?
  return false if @project_ids.nil?
  return false if @stories_without_projects.nil?
  return false if @name.nil?
  return false if @completed.nil?
  return false if @comments.nil?
  return false if @state.nil?
  return false if @requested_by_id.nil?
  return false if @epic_state_id.nil?
  return false if @label_ids.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 @position.nil?
  return false if @stats.nil?
  true
end