Class: SlackWebApi::ObjsEnterpriseUser

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/slack_web_api/models/objs_enterprise_user.rb

Overview

ObjsEnterpriseUser Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(enterprise_id:, enterprise_name:, id:, is_admin:, is_owner:, teams:, additional_properties: nil) ⇒ ObjsEnterpriseUser

Returns a new instance of ObjsEnterpriseUser.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 58

def initialize(enterprise_id:, enterprise_name:, id:, is_admin:, is_owner:,
               teams:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @enterprise_id = enterprise_id
  @enterprise_name = enterprise_name
  @id = id
  @is_admin = is_admin
  @is_owner = is_owner
  @teams = teams
  @additional_properties = additional_properties
end

Instance Attribute Details

#enterprise_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 14

def enterprise_id
  @enterprise_id
end

#enterprise_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 18

def enterprise_name
  @enterprise_name
end

#id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 22

def id
  @id
end

#is_admin ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


26
27
28
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 26

def is_admin
  @is_admin
end

#is_owner ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


30
31
32
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 30

def is_owner
  @is_owner
end

#teams ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


34
35
36
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 34

def teams
  @teams
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  enterprise_id = hash.key?('enterprise_id') ? hash['enterprise_id'] : nil
  enterprise_name =
    hash.key?('enterprise_name') ? hash['enterprise_name'] : nil
  id = hash.key?('id') ? hash['id'] : nil
  is_admin = hash.key?('is_admin') ? hash['is_admin'] : nil
  is_owner = hash.key?('is_owner') ? hash['is_owner'] : nil
  teams = hash.key?('teams') ? hash['teams'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ObjsEnterpriseUser.new(enterprise_id: enterprise_id,
                         enterprise_name: enterprise_name,
                         id: id,
                         is_admin: is_admin,
                         is_owner: is_owner,
                         teams: teams,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['enterprise_id'] = 'enterprise_id'
  @_hash['enterprise_name'] = 'enterprise_name'
  @_hash['id'] = 'id'
  @_hash['is_admin'] = 'is_admin'
  @_hash['is_owner'] = 'is_owner'
  @_hash['teams'] = 'teams'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



54
55
56
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 54

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



49
50
51
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 49

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



111
112
113
114
115
116
117
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 111

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} enterprise_id: #{@enterprise_id.inspect}, enterprise_name:"\
  " #{@enterprise_name.inspect}, id: #{@id.inspect}, is_admin: #{@is_admin.inspect}, is_owner:"\
  " #{@is_owner.inspect}, teams: #{@teams.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



103
104
105
106
107
108
 
# File 'lib/slack_web_api/models/objs_enterprise_user.rb', line 103

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} enterprise_id: #{@enterprise_id}, enterprise_name: #{@enterprise_name}, id:"\
  " #{@id}, is_admin: #{@is_admin}, is_owner: #{@is_owner}, teams: #{@teams},"\
  " additional_properties: #{@additional_properties}>"
end