Class: WhatpulseSdk::DetailedSubteamResource

Inherits:
Object
  • Object
show all
Defined in:
lib/whatpulse-sdk/models/detailed_subteam_resource.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DetailedSubteamResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
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
160
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `WhatpulseSdk::DetailedSubteamResource` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `WhatpulseSdk::DetailedSubteamResource`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  else
    self.description = nil
  end

  if attributes.key?(:'date_created')
    self.date_created = attributes[:'date_created']
  else
    self.date_created = nil
  end

  if attributes.key?(:'founder_id')
    self.founder_id = attributes[:'founder_id']
  else
    self.founder_id = nil
  end

  if attributes.key?(:'members_count')
    self.members_count = attributes[:'members_count']
  else
    self.members_count = nil
  end

  if attributes.key?(:'team_id')
    self.team_id = attributes[:'team_id']
  else
    self.team_id = nil
  end

  if attributes.key?(:'totals')
    self.totals = attributes[:'totals']
  else
    self.totals = nil
  end

  if attributes.key?(:'links')
    self.links = attributes[:'links']
  else
    self.links = nil
  end
end

Instance Attribute Details

#date_createdObject

The date the subteam was created, in ISO 8601 format.



28
29
30
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 28

def date_created
  @date_created
end

#descriptionObject

The public description of the subteam.



25
26
27
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 25

def description
  @description
end

#founder_idObject

The unique identifier for the founder of the subteam.



31
32
33
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 31

def founder_id
  @founder_id
end

#idObject

The unique identifier for the subteam.



19
20
21
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 19

def id
  @id
end

Returns the value of attribute links.



41
42
43
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 41

def links
  @links
end

#members_countObject

The total number of members in the subteam.



34
35
36
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 34

def members_count
  @members_count
end

#nameObject

The name of the subteam.



22
23
24
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 22

def name
  @name
end

#team_idObject

The unique identifier for the parent team.



37
38
39
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 37

def team_id
  @team_id
end

#totalsObject

Returns the value of attribute totals.



39
40
41
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 39

def totals
  @totals
end

Class Method Details

._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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 337

def self._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 = WhatpulseSdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



59
60
61
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



64
65
66
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 44

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'date_created' => :'date_created',
    :'founder_id' => :'founder_id',
    :'members_count' => :'members_count',
    :'team_id' => :'team_id',
    :'totals' => :'totals',
    :'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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 313

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



84
85
86
87
88
89
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 84

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

.openapi_typesObject

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 69

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'description' => :'String',
    :'date_created' => :'String',
    :'founder_id' => :'Integer',
    :'members_count' => :'Integer',
    :'team_id' => :'Integer',
    :'totals' => :'DetailedSubteamResourceTotals',
    :'links' => :'DetailedSubteamResourceLinks'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



284
285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      date_created == o.date_created &&
      founder_id == o.founder_id &&
      members_count == o.members_count &&
      team_id == o.team_id &&
      totals == o.totals &&
      links == o.links
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



408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 408

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


300
301
302
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 300

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



306
307
308
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 306

def hash
  [id, name, description, date_created, founder_id, members_count, team_id, totals, links].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
196
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 164

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



384
385
386
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 384

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 390

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



378
379
380
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 378

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



200
201
202
203
204
205
206
207
208
209
210
# File 'lib/whatpulse-sdk/models/detailed_subteam_resource.rb', line 200

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  return false if @date_created.nil?
  return false if @members_count.nil?
  return false if @team_id.nil?
  return false if @totals.nil?
  return false if @links.nil?
  true
end