Class: Shortcut::CreateStoryParams

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

Overview

Request parameters for creating a story.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateStoryParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
308
309
310
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
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 208

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

Controls the story’s archived state.



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

def archived
  @archived
end

#comments ⇒ Object

An array of comments to add to the story.



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

def comments
  @comments
end

#completed_at_override ⇒ Object

A manual override for the time/date the Story was completed.



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

def completed_at_override
  @completed_at_override
end

#created_at ⇒ Object

The time/date the Story was created.



98
99
100
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 98

def created_at
  @created_at
end

#deadline ⇒ Object

The due date of the story.



95
96
97
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 95

def deadline
  @deadline
end

#description ⇒ Object

The description of the story.



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

def description
  @description
end

#epic_id ⇒ Object

The ID of the epic the story belongs to.



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

def epic_id
  @epic_id
end

#estimate ⇒ Object

The numeric point estimate of the story. Can also be null, which means unestimated.



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

def estimate
  @estimate
end

#external_id ⇒ Object

This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.



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

def external_id
  @external_id
end

#external_links ⇒ Object

An array of External Links associated with this story.



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

def external_links
  @external_links
end

#file_ids ⇒ Object

An array of IDs of files attached to the story.



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

def file_ids
  @file_ids
end

#follower_ids ⇒ Object

An array of UUIDs of the followers of this story.



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

def follower_ids
  @follower_ids
end

#group_id ⇒ Object

The id of the group to associate with this story.



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

def group_id
  @group_id
end

#iteration_id ⇒ Object

The ID of the iteration the story belongs to.



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

def iteration_id
  @iteration_id
end

#labels ⇒ Object

An array of labels attached to the story.



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

def labels
  @labels
end

#linked_file_ids ⇒ Object

An array of IDs of linked files attached to the story.



92
93
94
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 92

def linked_file_ids
  @linked_file_ids
end

#name ⇒ Object

The name of the story.



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

def name
  @name
end

#owner_ids ⇒ Object

An array of UUIDs of the owners of this story.



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

def owner_ids
  @owner_ids
end

#project_id ⇒ Object

The ID of the project the story belongs to.



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

def project_id
  @project_id
end

#requested_by_id ⇒ Object

The ID of the member that requested the story.



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

def requested_by_id
  @requested_by_id
end

#started_at_override ⇒ Object

A manual override for the time/date the Story was started.



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

def started_at_override
  @started_at_override
end

#story_links ⇒ Object

An array of story links attached to the story.



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

def story_links
  @story_links
end

#story_template_id ⇒ Object

The id of the story template used to create this story, if applicable.



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

def story_template_id
  @story_template_id
end

#story_type ⇒ Object

The type of story (feature, bug, chore).



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

def story_type
  @story_type
end

#tasks ⇒ Object

An array of tasks connected to the story.



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

def tasks
  @tasks
end

#updated_at ⇒ Object

The time/date the Story was updated.



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

def updated_at
  @updated_at
end

#workflow_state_id ⇒ Object

The ID of the workflow state the story will be in.



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

def workflow_state_id
  @workflow_state_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



156
157
158
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 156

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'description' => :'description',
    :'archived' => :'archived',
    :'story_links' => :'story_links',
    :'labels' => :'labels',
    :'story_type' => :'story_type',
    :'file_ids' => :'file_ids',
    :'completed_at_override' => :'completed_at_override',
    :'name' => :'name',
    :'comments' => :'comments',
    :'epic_id' => :'epic_id',
    :'story_template_id' => :'story_template_id',
    :'external_links' => :'external_links',
    :'requested_by_id' => :'requested_by_id',
    :'iteration_id' => :'iteration_id',
    :'tasks' => :'tasks',
    :'started_at_override' => :'started_at_override',
    :'group_id' => :'group_id',
    :'workflow_state_id' => :'workflow_state_id',
    :'updated_at' => :'updated_at',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'external_id' => :'external_id',
    :'estimate' => :'estimate',
    :'project_id' => :'project_id',
    :'linked_file_ids' => :'linked_file_ids',
    :'deadline' => :'deadline',
    :'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



494
495
496
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 494

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 194

def self.openapi_nullable
  Set.new([
    :'epic_id',
    :'story_template_id',
    :'iteration_id',
    :'group_id',
    :'estimate',
    :'project_id',
    :'deadline',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'description' => :'String',
    :'archived' => :'Boolean',
    :'story_links' => :'Array<CreateStoryLinkParams>',
    :'labels' => :'Array<CreateLabelParams>',
    :'story_type' => :'String',
    :'file_ids' => :'Array<Integer>',
    :'completed_at_override' => :'Time',
    :'name' => :'String',
    :'comments' => :'Array<CreateStoryCommentParams>',
    :'epic_id' => :'Integer',
    :'story_template_id' => :'String',
    :'external_links' => :'Array<String>',
    :'requested_by_id' => :'String',
    :'iteration_id' => :'Integer',
    :'tasks' => :'Array<CreateTaskParams>',
    :'started_at_override' => :'Time',
    :'group_id' => :'String',
    :'workflow_state_id' => :'Integer',
    :'updated_at' => :'Time',
    :'follower_ids' => :'Array<String>',
    :'owner_ids' => :'Array<String>',
    :'external_id' => :'String',
    :'estimate' => :'Integer',
    :'project_id' => :'Integer',
    :'linked_file_ids' => :'Array<Integer>',
    :'deadline' => :'Time',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



447
448
449
450
451
452
453
454
455
456
457
458
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/create_story_params.rb', line 447

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      archived == o.archived &&
      story_links == o.story_links &&
      labels == o.labels &&
      story_type == o.story_type &&
      file_ids == o.file_ids &&
      completed_at_override == o.completed_at_override &&
      name == o.name &&
      comments == o.comments &&
      epic_id == o.epic_id &&
      story_template_id == o.story_template_id &&
      external_links == o.external_links &&
      requested_by_id == o.requested_by_id &&
      iteration_id == o.iteration_id &&
      tasks == o.tasks &&
      started_at_override == o.started_at_override &&
      group_id == o.group_id &&
      workflow_state_id == o.workflow_state_id &&
      updated_at == o.updated_at &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      external_id == o.external_id &&
      estimate == o.estimate &&
      project_id == o.project_id &&
      linked_file_ids == o.linked_file_ids &&
      deadline == o.deadline &&
      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



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 525

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



596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 596

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



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 501

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


481
482
483
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 481

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



487
488
489
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 487

def hash
  [description, archived, story_links, labels, story_type, file_ids, completed_at_override, name, comments, epic_id, story_template_id, external_links, requested_by_id, iteration_id, tasks, started_at_override, group_id, workflow_state_id, updated_at, follower_ids, owner_ids, external_id, estimate, project_id, linked_file_ids, deadline, 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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 350

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 100000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100000.')
  end

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

  if @name.to_s.length > 512
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 512.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  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



572
573
574
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 572

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



578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 578

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



566
567
568
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 566

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



373
374
375
376
377
378
379
380
381
 
# File 'lib/shortcut_client_ruby/models/create_story_params.rb', line 373

def valid?
  return false if !@description.nil? && @description.to_s.length > 100000
  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 @name.to_s.length > 512
  return false if @name.to_s.length < 1
  true
end