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



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

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_urlObject

The Shortcut application url for the Epic.



18
19
20
# File 'lib/shortcut_client_ruby/models/epic.rb', line 18

def app_url
  @app_url
end

#archivedObject

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



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

def archived
  @archived
end

#commentsObject

A nested array of threaded comments.



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

def comments
  @comments
end

#completedObject

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



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

def completed
  @completed
end

#completed_atObject

The time/date the Epic was completed.



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

def completed_at
  @completed_at
end

#completed_at_overrideObject

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



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

def completed_at_override
  @completed_at_override
end

#created_atObject

The time/date the Epic was created.



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

def created_at
  @created_at
end

#deadlineObject

The Epic’s deadline.



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

def deadline
  @deadline
end

#descriptionObject

The Epic’s description.



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

def description
  @description
end

#entity_typeObject

A string description of this resource.



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

def entity_type
  @entity_type
end

#epic_state_idObject

The ID of the Epic State.



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

def epic_state_id
  @epic_state_id
end

#external_idObject

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.



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

def external_id
  @external_id
end

#follower_idsObject

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



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

def follower_ids
  @follower_ids
end

#group_idObject

Returns the value of attribute group_id.



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

def group_id
  @group_id
end

#group_mention_idsObject

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



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

def group_mention_ids
  @group_mention_ids
end

#idObject

The unique ID of the Epic.



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

def id
  @id
end

#label_idsObject

An array of Label ids attached to the Epic.



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

def label_ids
  @label_ids
end

#labelsObject

An array of Labels attached to the Epic.



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

def labels
  @labels
end

#member_mention_idsObject

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



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

def member_mention_ids
  @member_mention_ids
end

#mention_idsObject

Deprecated: use member_mention_ids.



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

def mention_ids
  @mention_ids
end

#milestone_idObject

The ID of the Milestone this Epic is related to.



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

def milestone_id
  @milestone_id
end

#nameObject

The name of the Epic.



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

def name
  @name
end

#owner_idsObject

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



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

def owner_ids
  @owner_ids
end

#planned_start_dateObject

The Epic’s planned start date.



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

def planned_start_date
  @planned_start_date
end

#positionObject

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



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

def position
  @position
end

#productboard_idObject

The ID of the associated productboard feature.



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

def productboard_id
  @productboard_id
end

#productboard_nameObject

The name of the associated productboard feature.



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

def productboard_name
  @productboard_name
end

#productboard_plugin_idObject

The ID of the associated productboard integration.



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

def productboard_plugin_id
  @productboard_plugin_id
end

#productboard_urlObject

The URL of the associated productboard feature.



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

def productboard_url
  @productboard_url
end

#project_idsObject

The IDs of Projects related to this Epic.



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

def project_ids
  @project_ids
end

#requested_by_idObject

The ID of the Member that requested the epic.



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

def requested_by_id
  @requested_by_id
end

#startedObject

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



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

def started
  @started
end

#started_atObject

The time/date the Epic was started.



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

def started_at
  @started_at
end

#started_at_overrideObject

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



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

def started_at_override
  @started_at_override
end

#stateObject

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



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

def state
  @state
end

#statsObject

Returns the value of attribute stats.



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

def stats
  @stats
end

#stories_without_projectsObject

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



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

def stories_without_projects
  @stories_without_projects
end

#updated_atObject

The time/date the Epic was updated.



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_mapObject

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



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

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



687
688
689
# File 'lib/shortcut_client_ruby/models/epic.rb', line 687

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

.openapi_nullableObject

List of attributes with nullable: true



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/shortcut_client_ruby/models/epic.rb', line 218

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_typesObject

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

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



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
# File 'lib/shortcut_client_ruby/models/epic.rb', line 717

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    Shortcut.const_get(type).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



786
787
788
789
790
791
792
793
794
795
796
797
798
# File 'lib/shortcut_client_ruby/models/epic.rb', line 786

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



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
# File 'lib/shortcut_client_ruby/models/epic.rb', line 694

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


674
675
676
# File 'lib/shortcut_client_ruby/models/epic.rb', line 674

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



680
681
682
# File 'lib/shortcut_client_ruby/models/epic.rb', line 680

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_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
# File 'lib/shortcut_client_ruby/models/epic.rb', line 426

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

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

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

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

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

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

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

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

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

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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



762
763
764
# File 'lib/shortcut_client_ruby/models/epic.rb', line 762

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



768
769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/shortcut_client_ruby/models/epic.rb', line 768

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



756
757
758
# File 'lib/shortcut_client_ruby/models/epic.rb', line 756

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



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

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 @completed_at_override.nil?
  return false if @productboard_plugin_id.nil?
  return false if @started_at.nil?
  return false if @completed_at.nil?
  return false if @name.nil?
  return false if @completed.nil?
  return false if @comments.nil?
  return false if @productboard_url.nil?
  return false if @planned_start_date.nil?
  return false if @state.nil?
  return false if @milestone_id.nil?
  return false if @requested_by_id.nil?
  return false if @epic_state_id.nil?
  return false if @label_ids.nil?
  return false if @started_at_override.nil?
  return false if @group_id.nil?
  return false if @updated_at.nil?
  return false if @group_mention_ids.nil?
  return false if @productboard_id.nil?
  return false if @follower_ids.nil?
  return false if @owner_ids.nil?
  return false if @external_id.nil?
  return false if @id.nil?
  return false if @position.nil?
  return false if @productboard_name.nil?
  return false if @deadline.nil?
  return false if @stats.nil?
  return false if @created_at.nil?
  true
end