Class: Shortcut::SearchStories

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchStories

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
347
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 209

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

A true/false boolean indicating whether the Story is in archived state.



19
20
21
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 19

def archived
  @archived
end

#completed_at_end ⇒ Object

Stories should have been completed before this date.



37
38
39
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 37

def completed_at_end
  @completed_at_end
end

#completed_at_start ⇒ Object

Stories should have been competed after this date.



97
98
99
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 97

def completed_at_start
  @completed_at_start
end

#created_at_end ⇒ Object

Stories should have been created before this date.



73
74
75
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 73

def created_at_end
  @created_at_end
end

#created_at_start ⇒ Object

Stories should have been created after this date.



46
47
48
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 46

def created_at_start
  @created_at_start
end

#deadline_end ⇒ Object

Stories should have a deadline before this date.



43
44
45
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 43

def deadline_end
  @deadline_end
end

#deadline_start ⇒ Object

Stories should have a deadline after this date.



76
77
78
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 76

def deadline_start
  @deadline_start
end

#epic_id ⇒ Object

The Epic IDs that may be associated with the Stories.



49
50
51
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 49

def epic_id
  @epic_id
end

#epic_ids ⇒ Object

The Epic IDs that may be associated with the Stories.



28
29
30
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 28

def epic_ids
  @epic_ids
end

#estimate ⇒ Object

The number of estimate points associate with the Stories.



91
92
93
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 91

def estimate
  @estimate
end

#external_id ⇒ Object

An ID or URL that references an external resource. Useful during imports.



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

def external_id
  @external_id
end

#group_id ⇒ Object

The Group ID that is associated with the Stories



64
65
66
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 64

def group_id
  @group_id
end

#group_ids ⇒ Object

The Group IDs that are associated with the Stories



79
80
81
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 79

def group_ids
  @group_ids
end

#includes_description ⇒ Object

Whether to include the story description in the response.



88
89
90
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 88

def includes_description
  @includes_description
end

#iteration_id ⇒ Object

The Iteration ID that may be associated with the Stories.



58
59
60
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 58

def iteration_id
  @iteration_id
end

#iteration_ids ⇒ Object

The Iteration IDs that may be associated with the Stories.



70
71
72
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 70

def iteration_ids
  @iteration_ids
end

#label_ids ⇒ Object

The Label IDs that may be associated with the Stories.



61
62
63
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 61

def label_ids
  @label_ids
end

#label_name ⇒ Object

The name of any associated Labels.



52
53
54
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 52

def label_name
  @label_name
end

#owner_id ⇒ Object

An array of UUIDs for any Users who may be Owners of the Stories.



22
23
24
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 22

def owner_id
  @owner_id
end

#owner_ids ⇒ Object

An array of UUIDs for any Users who may be Owners of the Stories.



82
83
84
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 82

def owner_ids
  @owner_ids
end

#project_id ⇒ Object

The IDs for the Projects the Stories may be assigned to.



94
95
96
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 94

def project_id
  @project_id
end

#project_ids ⇒ Object

The IDs for the Projects the Stories may be assigned to.



31
32
33
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 31

def project_ids
  @project_ids
end

#requested_by_id ⇒ Object

The UUID of any Users who may have requested the Stories.



55
56
57
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 55

def requested_by_id
  @requested_by_id
end

#story_type ⇒ Object

The type of Stories that you want returned.



25
26
27
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 25

def story_type
  @story_type
end

#updated_at_end ⇒ Object

Stories should have been updated before this date.



34
35
36
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 34

def updated_at_end
  @updated_at_end
end

#updated_at_start ⇒ Object

Stories should have been updated after this date.



100
101
102
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 100

def updated_at_start
  @updated_at_start
end

#workflow_state_id ⇒ Object

The unique IDs of the specific Workflow States that the Stories should be in.



67
68
69
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 67

def workflow_state_id
  @workflow_state_id
end

#workflow_state_types ⇒ Object

The type of Workflow State the Stories may be in.



40
41
42
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 40

def workflow_state_types
  @workflow_state_types
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



159
160
161
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 159

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'archived' => :'archived',
    :'owner_id' => :'owner_id',
    :'story_type' => :'story_type',
    :'epic_ids' => :'epic_ids',
    :'project_ids' => :'project_ids',
    :'updated_at_end' => :'updated_at_end',
    :'completed_at_end' => :'completed_at_end',
    :'workflow_state_types' => :'workflow_state_types',
    :'deadline_end' => :'deadline_end',
    :'created_at_start' => :'created_at_start',
    :'epic_id' => :'epic_id',
    :'label_name' => :'label_name',
    :'requested_by_id' => :'requested_by_id',
    :'iteration_id' => :'iteration_id',
    :'label_ids' => :'label_ids',
    :'group_id' => :'group_id',
    :'workflow_state_id' => :'workflow_state_id',
    :'iteration_ids' => :'iteration_ids',
    :'created_at_end' => :'created_at_end',
    :'deadline_start' => :'deadline_start',
    :'group_ids' => :'group_ids',
    :'owner_ids' => :'owner_ids',
    :'external_id' => :'external_id',
    :'includes_description' => :'includes_description',
    :'estimate' => :'estimate',
    :'project_id' => :'project_id',
    :'completed_at_start' => :'completed_at_start',
    :'updated_at_start' => :'updated_at_start'
  }
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



475
476
477
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 475

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



198
199
200
201
202
203
204
205
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 198

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'archived' => :'Boolean',
    :'owner_id' => :'String',
    :'story_type' => :'String',
    :'epic_ids' => :'Array<Integer>',
    :'project_ids' => :'Array<Integer>',
    :'updated_at_end' => :'Time',
    :'completed_at_end' => :'Time',
    :'workflow_state_types' => :'Array<String>',
    :'deadline_end' => :'Time',
    :'created_at_start' => :'Time',
    :'epic_id' => :'Integer',
    :'label_name' => :'String',
    :'requested_by_id' => :'String',
    :'iteration_id' => :'Integer',
    :'label_ids' => :'Array<Integer>',
    :'group_id' => :'String',
    :'workflow_state_id' => :'Integer',
    :'iteration_ids' => :'Array<Integer>',
    :'created_at_end' => :'Time',
    :'deadline_start' => :'Time',
    :'group_ids' => :'Array<String>',
    :'owner_ids' => :'Array<String>',
    :'external_id' => :'String',
    :'includes_description' => :'Boolean',
    :'estimate' => :'Integer',
    :'project_id' => :'Integer',
    :'completed_at_start' => :'Time',
    :'updated_at_start' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 427

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      archived == o.archived &&
      owner_id == o.owner_id &&
      story_type == o.story_type &&
      epic_ids == o.epic_ids &&
      project_ids == o.project_ids &&
      updated_at_end == o.updated_at_end &&
      completed_at_end == o.completed_at_end &&
      workflow_state_types == o.workflow_state_types &&
      deadline_end == o.deadline_end &&
      created_at_start == o.created_at_start &&
      epic_id == o.epic_id &&
      label_name == o.label_name &&
      requested_by_id == o.requested_by_id &&
      iteration_id == o.iteration_id &&
      label_ids == o.label_ids &&
      group_id == o.group_id &&
      workflow_state_id == o.workflow_state_id &&
      iteration_ids == o.iteration_ids &&
      created_at_end == o.created_at_end &&
      deadline_start == o.deadline_start &&
      group_ids == o.group_ids &&
      owner_ids == o.owner_ids &&
      external_id == o.external_id &&
      includes_description == o.includes_description &&
      estimate == o.estimate &&
      project_id == o.project_id &&
      completed_at_start == o.completed_at_start &&
      updated_at_start == o.updated_at_start
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



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 506

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



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

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



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 482

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


462
463
464
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 462

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



468
469
470
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 468

def hash
  [archived, owner_id, story_type, epic_ids, project_ids, updated_at_end, completed_at_end, workflow_state_types, deadline_end, created_at_start, epic_id, label_name, requested_by_id, iteration_id, label_ids, group_id, workflow_state_id, iteration_ids, created_at_end, deadline_start, group_ids, owner_ids, external_id, includes_description, estimate, project_id, completed_at_start, updated_at_start].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



351
352
353
354
355
356
357
358
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 351

def list_invalid_properties
  invalid_properties = Array.new
  if !@label_name.nil? && @label_name.to_s.length < 1
    invalid_properties.push('invalid value for "label_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



553
554
555
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 553

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



559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 559

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



547
548
549
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 547

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



362
363
364
365
366
367
 
# File 'lib/shortcut_client_ruby/models/search_stories.rb', line 362

def valid?
  story_type_validator = EnumAttributeValidator.new('String', ["feature", "chore", "bug"])
  return false unless story_type_validator.valid?(@story_type)
  return false if !@label_name.nil? && @label_name.to_s.length < 1
  true
end