Class: Shortcut::UpdateStories

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateStories

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'story_ids')
    if (value = attributes[:'story_ids']).is_a?(Array)
      self.story_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?(:'follower_ids_add')
    if (value = attributes[:'follower_ids_add']).is_a?(Array)
      self.follower_ids_add = value
    end
  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?(:'follower_ids_remove')
    if (value = attributes[:'follower_ids_remove']).is_a?(Array)
      self.follower_ids_remove = 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?(:'labels_add')
    if (value = attributes[:'labels_add']).is_a?(Array)
      self.labels_add = value
    end
  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?(:'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?(:'owner_ids_remove')
    if (value = attributes[:'owner_ids_remove']).is_a?(Array)
      self.owner_ids_remove = value
    end
  end

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

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

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

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

Instance Attribute Details

#after_id ⇒ Object

The ID of the story that the stories are to be moved below.



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

def after_id
  @after_id
end

#archived ⇒ Object

If the Stories should be archived or not.



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

def archived
  @archived
end

#before_id ⇒ Object

The ID of the story that the stories are to be moved before.



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

def before_id
  @before_id
end

#deadline ⇒ Object

The due date of the story.



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

def deadline
  @deadline
end

#epic_id ⇒ Object

The ID of the epic the story belongs to.



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

def epic_id
  @epic_id
end

#estimate ⇒ Object

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



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

def estimate
  @estimate
end

#external_links ⇒ Object

An array of External Links associated with this story.



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

def external_links
  @external_links
end

#follower_ids_add ⇒ Object

The UUIDs of the new followers to be added.



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

def follower_ids_add
  @follower_ids_add
end

#follower_ids_remove ⇒ Object

The UUIDs of the followers to be removed.



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

def follower_ids_remove
  @follower_ids_remove
end

#group_id ⇒ Object

The Id of the Group the Stories should belong to.



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

def group_id
  @group_id
end

#iteration_id ⇒ Object

The ID of the iteration the story belongs to.



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

def iteration_id
  @iteration_id
end

#labels_add ⇒ Object

An array of labels to be added.



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

def labels_add
  @labels_add
end

#labels_remove ⇒ Object

An array of labels to be removed.



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

def labels_remove
  @labels_remove
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.



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

def move_to
  @move_to
end

#owner_ids_add ⇒ Object

The UUIDs of the new owners to be added.



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

def owner_ids_add
  @owner_ids_add
end

#owner_ids_remove ⇒ Object

The UUIDs of the owners to be removed.



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

def owner_ids_remove
  @owner_ids_remove
end

#project_id ⇒ Object

The ID of the Project the Stories should belong to.



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

def project_id
  @project_id
end

#requested_by_id ⇒ Object

The ID of the member that requested the story.



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

def requested_by_id
  @requested_by_id
end

#story_ids ⇒ Object

The Ids of the Stories you wish to update.



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

def story_ids
  @story_ids
end

#story_type ⇒ Object

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



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

def story_type
  @story_type
end

#workflow_state_id ⇒ Object

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



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

def workflow_state_id
  @workflow_state_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 104

def self.attribute_map
  {
    :'archived' => :'archived',
    :'story_ids' => :'story_ids',
    :'story_type' => :'story_type',
    :'move_to' => :'move_to',
    :'follower_ids_add' => :'follower_ids_add',
    :'epic_id' => :'epic_id',
    :'external_links' => :'external_links',
    :'follower_ids_remove' => :'follower_ids_remove',
    :'requested_by_id' => :'requested_by_id',
    :'iteration_id' => :'iteration_id',
    :'labels_add' => :'labels_add',
    :'group_id' => :'group_id',
    :'workflow_state_id' => :'workflow_state_id',
    :'before_id' => :'before_id',
    :'estimate' => :'estimate',
    :'after_id' => :'after_id',
    :'owner_ids_remove' => :'owner_ids_remove',
    :'project_id' => :'project_id',
    :'labels_remove' => :'labels_remove',
    :'deadline' => :'deadline',
    :'owner_ids_add' => :'owner_ids_add'
  }
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



409
410
411
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 409

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 163

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'archived' => :'Boolean',
    :'story_ids' => :'Array<Integer>',
    :'story_type' => :'String',
    :'move_to' => :'String',
    :'follower_ids_add' => :'Array<String>',
    :'epic_id' => :'Integer',
    :'external_links' => :'Array<String>',
    :'follower_ids_remove' => :'Array<String>',
    :'requested_by_id' => :'String',
    :'iteration_id' => :'Integer',
    :'labels_add' => :'Array<CreateLabelParams>',
    :'group_id' => :'String',
    :'workflow_state_id' => :'Integer',
    :'before_id' => :'Integer',
    :'estimate' => :'Integer',
    :'after_id' => :'Integer',
    :'owner_ids_remove' => :'Array<String>',
    :'project_id' => :'Integer',
    :'labels_remove' => :'Array<CreateLabelParams>',
    :'deadline' => :'Time',
    :'owner_ids_add' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      archived == o.archived &&
      story_ids == o.story_ids &&
      story_type == o.story_type &&
      move_to == o.move_to &&
      follower_ids_add == o.follower_ids_add &&
      epic_id == o.epic_id &&
      external_links == o.external_links &&
      follower_ids_remove == o.follower_ids_remove &&
      requested_by_id == o.requested_by_id &&
      iteration_id == o.iteration_id &&
      labels_add == o.labels_add &&
      group_id == o.group_id &&
      workflow_state_id == o.workflow_state_id &&
      before_id == o.before_id &&
      estimate == o.estimate &&
      after_id == o.after_id &&
      owner_ids_remove == o.owner_ids_remove &&
      project_id == o.project_id &&
      labels_remove == o.labels_remove &&
      deadline == o.deadline &&
      owner_ids_add == o.owner_ids_add
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



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

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



511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 511

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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 416

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


396
397
398
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 396

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



402
403
404
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 402

def hash
  [archived, story_ids, story_type, move_to, follower_ids_add, epic_id, external_links, follower_ids_remove, requested_by_id, iteration_id, labels_add, group_id, workflow_state_id, before_id, estimate, after_id, owner_ids_remove, project_id, labels_remove, deadline, owner_ids_add].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



292
293
294
295
296
297
298
299
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 292

def list_invalid_properties
  invalid_properties = Array.new
  if @story_ids.nil?
    invalid_properties.push('invalid value for "story_ids", story_ids 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



487
488
489
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 487

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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 493

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



481
482
483
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 481

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



303
304
305
306
307
308
309
310
 
# File 'lib/shortcut_client_ruby/models/update_stories.rb', line 303

def valid?
  return false if @story_ids.nil?
  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)
  true
end