Class: Shortcut::Group

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

Overview

A Group.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Group

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_url ⇒ Object

The Shortcut application url for the Group.



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

def app_url
  @app_url
end

#archived ⇒ Object

Whether or not the Group is archived.



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

def archived
  @archived
end

#color ⇒ Object

The hex color to be displayed with the Group (for example, "#ff0000").



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

def color
  @color
end

#color_key ⇒ Object

The color key to be displayed with the Group.



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

def color_key
  @color_key
end

#description ⇒ Object

The description of the Group.



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

def description
  @description
end

#display_icon ⇒ Object

Returns the value of attribute display_icon.



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

def display_icon
  @display_icon
end

#entity_type ⇒ Object

A string description of this resource.



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

def entity_type
  @entity_type
end

#id ⇒ Object

The id of the Group.



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

def id
  @id
end

#member_ids ⇒ Object

The Member IDs contain within the Group.



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

def member_ids
  @member_ids
end

#mention_name ⇒ Object

The mention name of the Group.



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

def mention_name
  @mention_name
end

#name ⇒ Object

The name of the Group.



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

def name
  @name
end

#num_epics_started ⇒ Object

The number of epics assigned to the group which are in the started workflow state.



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

def num_epics_started
  @num_epics_started
end

#num_stories ⇒ Object

The total number of stories assigned ot the group.



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

def num_stories
  @num_stories
end

#num_stories_started ⇒ Object

The number of stories assigned to the group which are in a started workflow state.



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

def num_stories_started
  @num_stories_started
end

#story_workflow_ids ⇒ Object

The Workflow IDs which have stories assigned to the group.



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

def story_workflow_ids
  @story_workflow_ids
end

#workflow_ids ⇒ Object

The Workflow IDs contained within the Group.



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

def workflow_ids
  @workflow_ids
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 87

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'archived' => :'archived',
    :'entity_type' => :'entity_type',
    :'color' => :'color',
    :'num_stories_started' => :'num_stories_started',
    :'mention_name' => :'mention_name',
    :'name' => :'name',
    :'color_key' => :'color_key',
    :'num_stories' => :'num_stories',
    :'num_epics_started' => :'num_epics_started',
    :'id' => :'id',
    :'display_icon' => :'display_icon',
    :'member_ids' => :'member_ids',
    :'story_workflow_ids' => :'story_workflow_ids',
    :'workflow_ids' => :'workflow_ids'
  }
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



367
368
369
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 367

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
135
136
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 131

def self.openapi_nullable
  Set.new([
    :'color',
    :'color_key',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/group.rb', line 109

def self.openapi_types
  {
    :'app_url' => :'Object',
    :'description' => :'Object',
    :'archived' => :'Object',
    :'entity_type' => :'Object',
    :'color' => :'Object',
    :'num_stories_started' => :'Object',
    :'mention_name' => :'Object',
    :'name' => :'Object',
    :'color_key' => :'Object',
    :'num_stories' => :'Object',
    :'num_epics_started' => :'Object',
    :'id' => :'Object',
    :'display_icon' => :'Object',
    :'member_ids' => :'Object',
    :'story_workflow_ids' => :'Object',
    :'workflow_ids' => :'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
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      description == o.description &&
      archived == o.archived &&
      entity_type == o.entity_type &&
      color == o.color &&
      num_stories_started == o.num_stories_started &&
      mention_name == o.mention_name &&
      name == o.name &&
      color_key == o.color_key &&
      num_stories == o.num_stories &&
      num_epics_started == o.num_epics_started &&
      id == o.id &&
      display_icon == o.display_icon &&
      member_ids == o.member_ids &&
      story_workflow_ids == o.story_workflow_ids &&
      workflow_ids == o.workflow_ids
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



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
430
431
432
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 397

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



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 466

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



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

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


354
355
356
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 354

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



360
361
362
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 360

def hash
  [app_url, description, archived, entity_type, color, num_stories_started, mention_name, name, color_key, num_stories, num_epics_started, id, display_icon, member_ids, story_workflow_ids, workflow_ids].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



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

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

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

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

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

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

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

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

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

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

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

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

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

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



442
443
444
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 442

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



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 448

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



436
437
438
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 436

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/shortcut_client_ruby/models/group.rb', line 297

def valid?
  return false if @app_url.nil?
  return false if @description.nil?
  return false if @archived.nil?
  return false if @entity_type.nil?
  return false if @color.nil?
  return false if @num_stories_started.nil?
  return false if @mention_name.nil?
  return false if @name.nil?
  return false if @color_key.nil?
  color_key_validator = EnumAttributeValidator.new('Object', ['blue', 'purple', 'midnight-blue', 'orange', 'yellow-green', 'brass', 'gray', 'fuchsia', 'yellow', 'pink', 'sky-blue', 'green', 'red', 'black', 'slate', 'turquoise'])
  return false unless color_key_validator.valid?(@color_key)
  return false if @num_stories.nil?
  return false if @num_epics_started.nil?
  return false if @id.nil?
  return false if @display_icon.nil?
  return false if @member_ids.nil?
  return false if @story_workflow_ids.nil?
  return false if @workflow_ids.nil?
  true
end