Class: Shortcut::Label

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

Overview

A Label can be used to associate and filter Stories and Epics, and also create new Workspaces.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Label

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 103

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

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

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

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

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

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

Instance Attribute Details

#app_url ⇒ Object

The Shortcut application url for the Label.



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

def app_url
  @app_url
end

#archived ⇒ Object

A true/false boolean indicating if the Label has been archived.



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

def archived
  @archived
end

#color ⇒ Object

The hex color to be displayed with the Label (for example, "#ff0000").



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

def color
  @color
end

#created_at ⇒ Object

The time/date that the Label was created.



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

def created_at
  @created_at
end

#description ⇒ Object

The description of the Label.



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

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



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

def entity_type
  @entity_type
end

#external_id ⇒ Object

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



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

def external_id
  @external_id
end

#id ⇒ Object

The unique ID of the Label.



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

def id
  @id
end

#name ⇒ Object

The name of the Label.



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

def name
  @name
end

#stats ⇒ Object

Returns the value of attribute stats.



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

def stats
  @stats
end

#updated_at ⇒ Object

The time/date that the Label was updated.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'archived' => :'archived',
    :'entity_type' => :'entity_type',
    :'color' => :'color',
    :'name' => :'name',
    :'updated_at' => :'updated_at',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'stats' => :'stats',
    :'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



258
259
260
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
95
96
97
98
99
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 91

def self.openapi_nullable
  Set.new([
    :'description',
    :'color',
    :'updated_at',
    :'external_id',
    :'created_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'app_url' => :'String',
    :'description' => :'String',
    :'archived' => :'Boolean',
    :'entity_type' => :'String',
    :'color' => :'String',
    :'name' => :'String',
    :'updated_at' => :'Time',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'stats' => :'LabelStats',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      description == o.description &&
      archived == o.archived &&
      entity_type == o.entity_type &&
      color == o.color &&
      name == o.name &&
      updated_at == o.updated_at &&
      external_id == o.external_id &&
      id == o.id &&
      stats == o.stats &&
      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



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

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



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

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 265

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


245
246
247
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 251

def hash
  [app_url, description, archived, entity_type, color, name, updated_at, external_id, id, stats, 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



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

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

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

  if @color.to_s.length < 1
    invalid_properties.push('invalid value for "color", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^#[a-fA-F0-9]{6}$/)
  if @color !~ pattern
    invalid_properties.push("invalid value for \"color\", must conform to the pattern #{pattern}.")
  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

  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



336
337
338
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 336

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



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

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



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

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



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/shortcut_client_ruby/models/label.rb', line 199

def valid?
  return false if @app_url.nil?
  return false if @archived.nil?
  return false if @entity_type.nil?
  return false if @color.to_s.length < 1
  return false if @color !~ Regexp.new(/^#[a-fA-F0-9]{6}$/)
  return false if @name.nil?
  return false if @id.nil?
  true
end