Class: Shortcut::WorkflowState

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

Overview

Workflow State is any of the at least 3 columns. Workflow States correspond to one of 3 types: Unstarted, Started, or Done.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowState

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
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
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
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#color ⇒ Object

The hex color for this Workflow State.



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

def color
  @color
end

#created_at ⇒ Object

The time/date the Workflow State was created.



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

def created_at
  @created_at
end

#description ⇒ Object

The description of what sort of Stories belong in that Workflow state.



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

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



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

def entity_type
  @entity_type
end

#id ⇒ Object

The unique ID of the Workflow State.



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

def id
  @id
end

#name ⇒ Object

The Workflow State’s name.



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

def name
  @name
end

#num_stories ⇒ Object

The number of Stories currently in that Workflow State.



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

def num_stories
  @num_stories
end

#num_story_templates ⇒ Object

The number of Story Templates associated with that Workflow State.



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

def num_story_templates
  @num_story_templates
end

#position ⇒ Object

The position that the Workflow State is in, starting with 0 at the left.



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

def position
  @position
end

#type ⇒ Object

The type of Workflow State (Unstarted, Started, or Finished)



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

def type
  @type
end

#updated_at ⇒ Object

When the Workflow State was last updated.



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

def updated_at
  @updated_at
end

#verb ⇒ Object

The verb that triggers a move to that Workflow State when making VCS commits.



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

def verb
  @verb
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 54

def self.attribute_map
  {
    :'description' => :'description',
    :'entity_type' => :'entity_type',
    :'color' => :'color',
    :'verb' => :'verb',
    :'name' => :'name',
    :'num_stories' => :'num_stories',
    :'type' => :'type',
    :'updated_at' => :'updated_at',
    :'id' => :'id',
    :'num_story_templates' => :'num_story_templates',
    :'position' => :'position',
    :'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



262
263
264
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 262

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
94
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 72

def self.openapi_types
  {
    :'description' => :'Object',
    :'entity_type' => :'Object',
    :'color' => :'Object',
    :'verb' => :'Object',
    :'name' => :'Object',
    :'num_stories' => :'Object',
    :'type' => :'Object',
    :'updated_at' => :'Object',
    :'id' => :'Object',
    :'num_story_templates' => :'Object',
    :'position' => :'Object',
    :'created_at' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      entity_type == o.entity_type &&
      color == o.color &&
      verb == o.verb &&
      name == o.name &&
      num_stories == o.num_stories &&
      type == o.type &&
      updated_at == o.updated_at &&
      id == o.id &&
      num_story_templates == o.num_story_templates &&
      position == o.position &&
      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



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

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 361

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 269

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


249
250
251
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 255

def hash
  [description, entity_type, color, verb, name, num_stories, type, updated_at, id, num_story_templates, position, 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



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

def list_invalid_properties
  invalid_properties = Array.new
  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 @verb.nil?
    invalid_properties.push('invalid value for "verb", verb cannot be nil.')
  end

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

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

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

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

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

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

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



337
338
339
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 337

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



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

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



331
332
333
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 331

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/shortcut_client_ruby/models/workflow_state.rb', line 213

def valid?
  return false if @description.nil?
  return false if @entity_type.nil?
  return false if @verb.nil?
  return false if @name.nil?
  return false if @num_stories.nil?
  return false if @type.nil?
  return false if @updated_at.nil?
  return false if @id.nil?
  return false if @num_story_templates.nil?
  return false if @position.nil?
  return false if @created_at.nil?
  true
end