Class: Shortcut::UpdateStory

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateStory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
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
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 203

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'commit_ids')
    if (value = attributes[:'commit_ids']).is_a?(Array)
      self.commit_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?(:'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?(:'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?(:'before_id')
    self.before_id = attributes[:'before_id']
  end

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

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

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

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

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

Instance Attribute Details

#after_id ⇒ Object

The ID of the story we want to move this story after.



85
86
87
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 85

def after_id
  @after_id
end

#archived ⇒ Object

True if the story is archived, otherwise false.



22
23
24
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 22

def archived
  @archived
end

#before_id ⇒ Object

The ID of the story we want to move this story before.



79
80
81
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 79

def before_id
  @before_id
end

#branch_ids ⇒ Object

An array of IDs of Branches attached to the story.



52
53
54
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 52

def branch_ids
  @branch_ids
end

#commit_ids ⇒ Object

An array of IDs of Commits attached to the story.



55
56
57
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 55

def commit_ids
  @commit_ids
end

#completed_at_override ⇒ Object

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



40
41
42
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 40

def completed_at_override
  @completed_at_override
end

#deadline ⇒ Object

The due date of the story.



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

def deadline
  @deadline
end

#description ⇒ Object

The description of the story.



19
20
21
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 19

def description
  @description
end

#epic_id ⇒ Object

The ID of the epic the story belongs to.



46
47
48
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 46

def epic_id
  @epic_id
end

#estimate ⇒ Object

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



82
83
84
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 82

def estimate
  @estimate
end

#external_links ⇒ Object

An array of External Links associated with this story.



49
50
51
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 49

def external_links
  @external_links
end

#file_ids ⇒ Object

An array of IDs of files attached to the story.



37
38
39
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 37

def file_ids
  @file_ids
end

#follower_ids ⇒ Object

An array of UUIDs of the followers of this story.



73
74
75
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 73

def follower_ids
  @follower_ids
end

#group_id ⇒ Object

The ID of the group to associate with this story



67
68
69
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 67

def group_id
  @group_id
end

#iteration_id ⇒ Object

The ID of the iteration the story belongs to.



61
62
63
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 61

def iteration_id
  @iteration_id
end

#labels ⇒ Object

An array of labels attached to the story.



25
26
27
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 25

def labels
  @labels
end

#linked_file_ids ⇒ Object

An array of IDs of linked files attached to the story.



91
92
93
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 91

def linked_file_ids
  @linked_file_ids
end

#move_to ⇒ Object

One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.



34
35
36
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 34

def move_to
  @move_to
end

#name ⇒ Object

The title of the story.



43
44
45
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 43

def name
  @name
end

#owner_ids ⇒ Object

An array of UUIDs of the owners of this story.



76
77
78
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 76

def owner_ids
  @owner_ids
end

#project_id ⇒ Object

The ID of the project the story belongs to.



88
89
90
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 88

def project_id
  @project_id
end

#pull_request_ids ⇒ Object

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



28
29
30
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 28

def pull_request_ids
  @pull_request_ids
end

#requested_by_id ⇒ Object

The ID of the member that requested the story.



58
59
60
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 58

def requested_by_id
  @requested_by_id
end

#started_at_override ⇒ Object

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



64
65
66
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 64

def started_at_override
  @started_at_override
end

#story_type ⇒ Object

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



31
32
33
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 31

def story_type
  @story_type
end

#workflow_state_id ⇒ Object

The ID of the workflow state to put the story in.



70
71
72
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 70

def workflow_state_id
  @workflow_state_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



151
152
153
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 151

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 119

def self.attribute_map
  {
    :'description' => :'description',
    :'archived' => :'archived',
    :'labels' => :'labels',
    :'pull_request_ids' => :'pull_request_ids',
    :'story_type' => :'story_type',
    :'move_to' => :'move_to',
    :'file_ids' => :'file_ids',
    :'completed_at_override' => :'completed_at_override',
    :'name' => :'name',
    :'epic_id' => :'epic_id',
    :'external_links' => :'external_links',
    :'branch_ids' => :'branch_ids',
    :'commit_ids' => :'commit_ids',
    :'requested_by_id' => :'requested_by_id',
    :'iteration_id' => :'iteration_id',
    :'started_at_override' => :'started_at_override',
    :'group_id' => :'group_id',
    :'workflow_state_id' => :'workflow_state_id',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'before_id' => :'before_id',
    :'estimate' => :'estimate',
    :'after_id' => :'after_id',
    :'project_id' => :'project_id',
    :'linked_file_ids' => :'linked_file_ids',
    :'deadline' => :'deadline'
  }
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



505
506
507
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 505

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 188

def self.openapi_nullable
  Set.new([
    :'completed_at_override',
    :'epic_id',
    :'iteration_id',
    :'started_at_override',
    :'group_id',
    :'estimate',
    :'project_id',
    :'deadline'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 156

def self.openapi_types
  {
    :'description' => :'String',
    :'archived' => :'Boolean',
    :'labels' => :'Array<CreateLabelParams>',
    :'pull_request_ids' => :'Array<Integer>',
    :'story_type' => :'String',
    :'move_to' => :'String',
    :'file_ids' => :'Array<Integer>',
    :'completed_at_override' => :'Time',
    :'name' => :'String',
    :'epic_id' => :'Integer',
    :'external_links' => :'Array<String>',
    :'branch_ids' => :'Array<Integer>',
    :'commit_ids' => :'Array<Integer>',
    :'requested_by_id' => :'String',
    :'iteration_id' => :'Integer',
    :'started_at_override' => :'Time',
    :'group_id' => :'String',
    :'workflow_state_id' => :'Integer',
    :'follower_ids' => :'Array<String>',
    :'owner_ids' => :'Array<String>',
    :'before_id' => :'Integer',
    :'estimate' => :'Integer',
    :'after_id' => :'Integer',
    :'project_id' => :'Integer',
    :'linked_file_ids' => :'Array<Integer>',
    :'deadline' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      archived == o.archived &&
      labels == o.labels &&
      pull_request_ids == o.pull_request_ids &&
      story_type == o.story_type &&
      move_to == o.move_to &&
      file_ids == o.file_ids &&
      completed_at_override == o.completed_at_override &&
      name == o.name &&
      epic_id == o.epic_id &&
      external_links == o.external_links &&
      branch_ids == o.branch_ids &&
      commit_ids == o.commit_ids &&
      requested_by_id == o.requested_by_id &&
      iteration_id == o.iteration_id &&
      started_at_override == o.started_at_override &&
      group_id == o.group_id &&
      workflow_state_id == o.workflow_state_id &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      before_id == o.before_id &&
      estimate == o.estimate &&
      after_id == o.after_id &&
      project_id == o.project_id &&
      linked_file_ids == o.linked_file_ids &&
      deadline == o.deadline
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



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

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



607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 607

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



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 512

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


492
493
494
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 492

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



498
499
500
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 498

def hash
  [description, archived, labels, pull_request_ids, story_type, move_to, file_ids, completed_at_override, name, epic_id, external_links, branch_ids, commit_ids, requested_by_id, iteration_id, started_at_override, group_id, workflow_state_id, follower_ids, owner_ids, before_id, estimate, after_id, project_id, linked_file_ids, deadline].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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 341

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 100000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100000.')
  end

  if !@name.nil? && @name.to_s.length > 512
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 512.')
  end

  if !@name.nil? && @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  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



583
584
585
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 583

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



589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 589

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



577
578
579
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 577

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



360
361
362
363
364
365
366
367
368
369
 
# File 'lib/shortcut_client_ruby/models/update_story.rb', line 360

def valid?
  return false if !@description.nil? && @description.to_s.length > 100000
  story_type_validator = EnumAttributeValidator.new('String', ["feature", "chore", "bug"])
  return false unless story_type_validator.valid?(@story_type)
  move_to_validator = EnumAttributeValidator.new('String', ["last", "first"])
  return false unless move_to_validator.valid?(@move_to)
  return false if !@name.nil? && @name.to_s.length > 512
  return false if !@name.nil? && @name.to_s.length < 1
  true
end