Class: Shortcut::Iteration

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

Overview

An Iteration is a defined, time-boxed period of development for a collection of Stories. See help.shortcut.com/hc/en-us/articles/360028953452-Iterations-Overview for more information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Iteration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



126
127
128
129
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 126

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

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

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

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

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

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

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



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

def app_url
  @app_url
end

#created_at ⇒ Object

The instant when this iteration was created.



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

def created_at
  @created_at
end

#description ⇒ Object

The description of the iteration.



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

def description
  @description
end

#end_date ⇒ Object

The date this iteration begins.



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

def end_date
  @end_date
end

#entity_type ⇒ Object

A string description of this resource



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

def entity_type
  @entity_type
end

#follower_ids ⇒ Object

An array of UUIDs for any Members listed as Followers.



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

def follower_ids
  @follower_ids
end

#group_ids ⇒ Object

An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.



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

def group_ids
  @group_ids
end

#group_mention_ids ⇒ Object

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



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

def group_mention_ids
  @group_mention_ids
end

#id ⇒ Object

The ID of the iteration.



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

def id
  @id
end

#label_ids ⇒ Object

An array of label ids attached to the iteration.



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

def label_ids
  @label_ids
end

#labels ⇒ Object

An array of labels attached to the iteration.



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

def labels
  @labels
end

#member_mention_ids ⇒ Object

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



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

def member_mention_ids
  @member_mention_ids
end

#mention_ids ⇒ Object

Deprecated: use member_mention_ids.



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

def mention_ids
  @mention_ids
end

#name ⇒ Object

The name of the iteration.



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

def name
  @name
end

#start_date ⇒ Object

The date this iteration begins.



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

def start_date
  @start_date
end

#stats ⇒ Object

Returns the value of attribute stats.



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

def stats
  @stats
end

#status ⇒ Object

The status of the iteration. Values are either "unstarted", "started", or "done".



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

def status
  @status
end

#updated_at ⇒ Object

The instant when this iteration was last updated.



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 71

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'entity_type' => :'entity_type',
    :'labels' => :'labels',
    :'mention_ids' => :'mention_ids',
    :'member_mention_ids' => :'member_mention_ids',
    :'name' => :'name',
    :'label_ids' => :'label_ids',
    :'updated_at' => :'updated_at',
    :'group_mention_ids' => :'group_mention_ids',
    :'end_date' => :'end_date',
    :'follower_ids' => :'follower_ids',
    :'group_ids' => :'group_ids',
    :'start_date' => :'start_date',
    :'status' => :'status',
    :'id' => :'id',
    :'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



369
370
371
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 369

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 95

def self.openapi_types
  {
    :'app_url' => :'Object',
    :'description' => :'Object',
    :'entity_type' => :'Object',
    :'labels' => :'Object',
    :'mention_ids' => :'Object',
    :'member_mention_ids' => :'Object',
    :'name' => :'Object',
    :'label_ids' => :'Object',
    :'updated_at' => :'Object',
    :'group_mention_ids' => :'Object',
    :'end_date' => :'Object',
    :'follower_ids' => :'Object',
    :'group_ids' => :'Object',
    :'start_date' => :'Object',
    :'status' => :'Object',
    :'id' => :'Object',
    :'stats' => :'Object',
    :'created_at' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      description == o.description &&
      entity_type == o.entity_type &&
      labels == o.labels &&
      mention_ids == o.mention_ids &&
      member_mention_ids == o.member_mention_ids &&
      name == o.name &&
      label_ids == o.label_ids &&
      updated_at == o.updated_at &&
      group_mention_ids == o.group_mention_ids &&
      end_date == o.end_date &&
      follower_ids == o.follower_ids &&
      group_ids == o.group_ids &&
      start_date == o.start_date &&
      status == o.status &&
      id == o.id &&
      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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 399

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



468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 468

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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 376

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


356
357
358
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 356

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



362
363
364
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 362

def hash
  [app_url, description, entity_type, labels, mention_ids, member_mention_ids, name, label_ids, updated_at, group_mention_ids, end_date, follower_ids, group_ids, start_date, status, id, 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



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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



444
445
446
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 444

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



450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 450

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



438
439
440
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 438

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/shortcut_client_ruby/models/iteration.rb', line 307

def valid?
  return false if @app_url.nil?
  return false if @description.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 @name.nil?
  return false if @label_ids.nil?
  return false if @updated_at.nil?
  return false if @group_mention_ids.nil?
  return false if @end_date.nil?
  return false if @follower_ids.nil?
  return false if @group_ids.nil?
  return false if @start_date.nil?
  return false if @status.nil?
  return false if @id.nil?
  return false if @stats.nil?
  return false if @created_at.nil?
  true
end