Class: SiteimproveAPIClient::IssueTrackerWorkItem

Inherits:
Object
  • Object
show all
Defined in:
lib/siteimprove_api_client/models/issue_tracker_work_item.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IssueTrackerWorkItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 104

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

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

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

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

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

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

  if attributes.key?(:'_module')
    self._module = attributes[:'_module']
  else
    self._module = 'quality_assurance'
  end

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



39
40
41
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 39

def _links
  @_links
end

#_module ⇒ Object

The Siteimprove module the task is related to.



37
38
39
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 37

def _module
  @_module
end

#created_by ⇒ Object

Name of the Siteimprove user who created the task.



22
23
24
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 22

def created_by
  @created_by
end

#created_time ⇒ Object

The time the task was created.



25
26
27
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 25

def created_time
  @created_time
end

#id ⇒ Object

Identifier of the individual task.



19
20
21
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 19

def id
  @id
end

#issue_link ⇒ Object

Url to view the task in a browser.



28
29
30
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 28

def issue_link
  @issue_link
end

#issuetracker_connection ⇒ Object

The connection to the project management system used for the task.



31
32
33
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 31

def issuetracker_connection
  @issuetracker_connection
end

#issuetracker_user ⇒ Object

The name of the Siteimprove user data that was used for creating the task.



34
35
36
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 34

def issuetracker_user
  @issuetracker_user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'created_by' => :'created_by',
    :'created_time' => :'created_time',
    :'issue_link' => :'issue_link',
    :'issuetracker_connection' => :'issuetracker_connection',
    :'issuetracker_user' => :'issuetracker_user',
    :'_module' => :'module',
    :'_links' => :'_links'
  }
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



217
218
219
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 217

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 83

def self.openapi_types
  {
    :'id' => :'String',
    :'created_by' => :'String',
    :'created_time' => :'Time',
    :'issue_link' => :'String',
    :'issuetracker_connection' => :'String',
    :'issuetracker_user' => :'String',
    :'_module' => :'String',
    :'_links' => :'Links10'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_by == o.created_by &&
      created_time == o.created_time &&
      issue_link == o.issue_link &&
      issuetracker_connection == o.issuetracker_connection &&
      issuetracker_user == o.issuetracker_user &&
      _module == o._module &&
      _links == o._links
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



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
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 248

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 = SiteimproveAPIClient.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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 319

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 224

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


204
205
206
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 210

def hash
  [id, created_by, created_time, issue_link, issuetracker_connection, issuetracker_user, _module, _links].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



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  if @created_time.nil?
    invalid_properties.push('invalid value for "created_time", created_time cannot be nil.')
  end

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



295
296
297
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 295

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 301

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



289
290
291
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 289

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



169
170
171
172
173
174
175
 
# File 'lib/siteimprove_api_client/models/issue_tracker_work_item.rb', line 169

def valid?
  return false if @created_time.nil?
  return false if @_module.nil?
  _module_validator = EnumAttributeValidator.new('String', ["quality_assurance", "analytics", "accessibility", "a11_y_next_gen", "seo", "policy"])
  return false unless _module_validator.valid?(@_module)
  true
end