Class: Shortcut::HistoryActionStoryCreate

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

Overview

An action representing a Story being created.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HistoryActionStoryCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 187

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

The action of the entity referenced.



80
81
82
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 80

def action
  @action
end

#app_url ⇒ Object

The application URL of the Story.



20
21
22
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 20

def app_url
  @app_url
end

#blocked ⇒ Object

Whether or not the Story is blocked by another Story.



83
84
85
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 83

def blocked
  @blocked
end

#blocker ⇒ Object

Whether or not the Story is blocking another Story.



44
45
46
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 44

def blocker
  @blocker
end

#completed ⇒ Object

Whether or not the Story is completed.



41
42
43
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 41

def completed
  @completed
end

#deadline ⇒ Object

The timestamp representing the Story’s deadline.



89
90
91
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 89

def deadline
  @deadline
end

#description ⇒ Object

The description of the Story.



23
24
25
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 23

def description
  @description
end

#entity_type ⇒ Object

The type of entity referenced.



29
30
31
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 29

def entity_type
  @entity_type
end

#epic_id ⇒ Object

The Epic ID for this Story.



47
48
49
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 47

def epic_id
  @epic_id
end

#estimate ⇒ Object

The estimate (or point value) for the Story.



74
75
76
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 74

def estimate
  @estimate
end

#follower_ids ⇒ Object

An array of Member IDs for the followers of the Story.



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

def follower_ids
  @follower_ids
end

#id ⇒ Object

The ID of the entity referenced.



71
72
73
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 71

def id
  @id
end

#iteration_id ⇒ Object

The Iteration ID the Story is in.



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

def iteration_id
  @iteration_id
end

#label_ids ⇒ Object

An array of Labels IDs attached to the Story.



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

def label_ids
  @label_ids
end

#name ⇒ Object

The name of the Story.



38
39
40
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 38

def name
  @name
end

#object_story_link_ids ⇒ Object

An array of Story IDs that are the object of a Story Link relationship.



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

def object_story_link_ids
  @object_story_link_ids
end

#owner_ids ⇒ Object

An array of Member IDs that are the owners of the Story.



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

def owner_ids
  @owner_ids
end

#project_id ⇒ Object

The Project ID of the Story is in.



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

def project_id
  @project_id
end

#requested_by_id ⇒ Object

The ID of the Member that requested the Story.



50
51
52
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 50

def requested_by_id
  @requested_by_id
end

#started ⇒ Object

Whether or not the Story has been started.



26
27
28
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 26

def started
  @started
end

#story_type ⇒ Object

The type of Story; either feature, bug, or chore.



35
36
37
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 35

def story_type
  @story_type
end

#subject_story_link_ids ⇒ Object

An array of Story IDs that are the subject of a Story Link relationship.



77
78
79
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 77

def subject_story_link_ids
  @subject_story_link_ids
end

#task_ids ⇒ Object

An array of Task IDs on this Story.



32
33
34
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 32

def task_ids
  @task_ids
end

#workflow_state_id ⇒ Object

An array of Workflow State IDs attached to the Story.



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

def workflow_state_id
  @workflow_state_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



144
145
146
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 144

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'started' => :'started',
    :'entity_type' => :'entity_type',
    :'task_ids' => :'task_ids',
    :'story_type' => :'story_type',
    :'name' => :'name',
    :'completed' => :'completed',
    :'blocker' => :'blocker',
    :'epic_id' => :'epic_id',
    :'requested_by_id' => :'requested_by_id',
    :'iteration_id' => :'iteration_id',
    :'label_ids' => :'label_ids',
    :'workflow_state_id' => :'workflow_state_id',
    :'object_story_link_ids' => :'object_story_link_ids',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'id' => :'id',
    :'estimate' => :'estimate',
    :'subject_story_link_ids' => :'subject_story_link_ids',
    :'action' => :'action',
    :'blocked' => :'blocked',
    :'project_id' => :'project_id',
    :'deadline' => :'deadline'
  }
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



452
453
454
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 452

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



179
180
181
182
183
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 179

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'app_url' => :'String',
    :'description' => :'String',
    :'started' => :'Boolean',
    :'entity_type' => :'String',
    :'task_ids' => :'Array<Integer>',
    :'story_type' => :'String',
    :'name' => :'String',
    :'completed' => :'Boolean',
    :'blocker' => :'Boolean',
    :'epic_id' => :'Integer',
    :'requested_by_id' => :'String',
    :'iteration_id' => :'Integer',
    :'label_ids' => :'Array<Integer>',
    :'workflow_state_id' => :'Integer',
    :'object_story_link_ids' => :'Array<Integer>',
    :'follower_ids' => :'Array<String>',
    :'owner_ids' => :'Array<String>',
    :'id' => :'Integer',
    :'estimate' => :'Integer',
    :'subject_story_link_ids' => :'Array<Integer>',
    :'action' => :'String',
    :'blocked' => :'Boolean',
    :'project_id' => :'Integer',
    :'deadline' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
435
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 408

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      description == o.description &&
      started == o.started &&
      entity_type == o.entity_type &&
      task_ids == o.task_ids &&
      story_type == o.story_type &&
      name == o.name &&
      completed == o.completed &&
      blocker == o.blocker &&
      epic_id == o.epic_id &&
      requested_by_id == o.requested_by_id &&
      iteration_id == o.iteration_id &&
      label_ids == o.label_ids &&
      workflow_state_id == o.workflow_state_id &&
      object_story_link_ids == o.object_story_link_ids &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      id == o.id &&
      estimate == o.estimate &&
      subject_story_link_ids == o.subject_story_link_ids &&
      action == o.action &&
      blocked == o.blocked &&
      project_id == o.project_id &&
      deadline == o.deadline
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



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 483

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



554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 554

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



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/history_action_story_create.rb', line 459

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


439
440
441
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 439

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



445
446
447
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 445

def hash
  [app_url, description, started, entity_type, task_ids, story_type, name, completed, blocker, epic_id, requested_by_id, iteration_id, label_ids, workflow_state_id, object_story_link_ids, follower_ids, owner_ids, id, estimate, subject_story_link_ids, action, blocked, project_id, deadline].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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 311

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 @app_url.to_s.length > 2048
    invalid_properties.push('invalid value for "app_url", the character length must be smaller than or equal to 2048.')
  end

  pattern = Regexp.new(/^https?:\/\/.+$/)
  if @app_url !~ pattern
    invalid_properties.push("invalid value for \"app_url\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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



530
531
532
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 530

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



536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 536

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



524
525
526
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 524

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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/shortcut_client_ruby/models/history_action_story_create.rb', line 351

def valid?
  return false if @app_url.nil?
  return false if @app_url.to_s.length > 2048
  return false if @app_url !~ Regexp.new(/^https?:\/\/.+$/)
  return false if @entity_type.nil?
  return false if @story_type.nil?
  story_type_validator = EnumAttributeValidator.new('String', ["feature", "chore", "bug"])
  return false unless story_type_validator.valid?(@story_type)
  return false if @name.nil?
  return false if @id.nil?
  return false if @action.nil?
  action_validator = EnumAttributeValidator.new('String', ["create"])
  return false unless action_validator.valid?(@action)
  true
end