Class: Shortcut::Workflow

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

Overview

Workflow is the array of defined Workflow States. Workflow can be queried using the API but must be updated in the Shortcut UI.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Workflow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
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
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 92

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_assign_owner ⇒ Object

Indicates if an owner is automatically assigned when an unowned story is started.



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

def auto_assign_owner
  @auto_assign_owner
end

#created_at ⇒ Object

The date the Workflow was created.



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

def created_at
  @created_at
end

#default_state_id ⇒ Object

The unique ID of the default state that new Stories are entered into.



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

def default_state_id
  @default_state_id
end

#description ⇒ Object

A description of the workflow.



18
19
20
 
# File 'lib/shortcut_client_ruby/models/workflow.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.rb', line 21

def entity_type
  @entity_type
end

#id ⇒ Object

The unique ID of the Workflow.



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

def id
  @id
end

#name ⇒ Object

The name of the workflow.



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

def name
  @name
end

#project_ids ⇒ Object

An array of IDs of projects within the Workflow.



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

def project_ids
  @project_ids
end

#states ⇒ Object

A map of the states in this Workflow.



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

def states
  @states
end

#team_id ⇒ Object

The ID of the team the workflow belongs to.



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

def team_id
  @team_id
end

#updated_at ⇒ Object

The date the Workflow was updated.



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 51

def self.attribute_map
  {
    :'description' => :'description',
    :'entity_type' => :'entity_type',
    :'project_ids' => :'project_ids',
    :'states' => :'states',
    :'name' => :'name',
    :'updated_at' => :'updated_at',
    :'auto_assign_owner' => :'auto_assign_owner',
    :'id' => :'id',
    :'team_id' => :'team_id',
    :'created_at' => :'created_at',
    :'default_state_id' => :'default_state_id'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 68

def self.openapi_types
  {
    :'description' => :'Object',
    :'entity_type' => :'Object',
    :'project_ids' => :'Object',
    :'states' => :'Object',
    :'name' => :'Object',
    :'updated_at' => :'Object',
    :'auto_assign_owner' => :'Object',
    :'id' => :'Object',
    :'team_id' => :'Object',
    :'created_at' => :'Object',
    :'default_state_id' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      entity_type == o.entity_type &&
      project_ids == o.project_ids &&
      states == o.states &&
      name == o.name &&
      updated_at == o.updated_at &&
      auto_assign_owner == o.auto_assign_owner &&
      id == o.id &&
      team_id == o.team_id &&
      created_at == o.created_at &&
      default_state_id == o.default_state_id
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



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

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 354

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 262

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


242
243
244
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 248

def hash
  [description, entity_type, project_ids, states, name, updated_at, auto_assign_owner, id, team_id, created_at, default_state_id].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



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

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

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

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

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

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

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

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

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

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



330
331
332
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 336

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



324
325
326
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 324

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 207

def valid?
  return false if @description.nil?
  return false if @entity_type.nil?
  return false if @project_ids.nil?
  return false if @states.nil?
  return false if @name.nil?
  return false if @updated_at.nil?
  return false if @auto_assign_owner.nil?
  return false if @id.nil?
  return false if @team_id.nil?
  return false if @created_at.nil?
  return false if @default_state_id.nil?
  true
end