Class: SlackWebApi::AuthTestSuccessSchema

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

Overview

Schema for successful response auth.test method

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(team:, team_id:, url:, user:, user_id:, bot_id: SKIP, is_enterprise_install: SKIP, additional_properties: nil) ⇒ AuthTestSuccessSchema

Returns a new instance of AuthTestSuccessSchema.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 71

def initialize(team:, team_id:, url:, user:, user_id:, bot_id: SKIP,
               is_enterprise_install: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @bot_id = bot_id unless bot_id == SKIP
  @is_enterprise_install = is_enterprise_install unless is_enterprise_install == SKIP
  @ok = 'True'
  @team = team
  @team_id = team_id
  @url = url
  @user = user
  @user_id = user_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#bot_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def bot_id
  @bot_id
end

#is_enterprise_install ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def is_enterprise_install
  @is_enterprise_install
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#team ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def team
  @team
end

#team_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def team_id
  @team_id
end

#url ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def url
  @url
end

#user ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 38

def user
  @user
end

#user_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


42
43
44
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 42

def user_id
  @user_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



88
89
90
91
92
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
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 88

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  team = hash.key?('team') ? hash['team'] : nil
  team_id = hash.key?('team_id') ? hash['team_id'] : nil
  url = hash.key?('url') ? hash['url'] : nil
  user = hash.key?('user') ? hash['user'] : nil
  user_id = hash.key?('user_id') ? hash['user_id'] : nil
  bot_id = hash.key?('bot_id') ? hash['bot_id'] : SKIP
  is_enterprise_install =
    hash.key?('is_enterprise_install') ? hash['is_enterprise_install'] : SKIP

  # 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.
  AuthTestSuccessSchema.new(team: team,
                            team_id: team_id,
                            url: url,
                            user: user,
                            user_id: user_id,
                            bot_id: bot_id,
                            is_enterprise_install: is_enterprise_install,
                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 45

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['bot_id'] = 'bot_id'
  @_hash['is_enterprise_install'] = 'is_enterprise_install'
  @_hash['ok'] = 'ok'
  @_hash['team'] = 'team'
  @_hash['team_id'] = 'team_id'
  @_hash['url'] = 'url'
  @_hash['user'] = 'user'
  @_hash['user_id'] = 'user_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



67
68
69
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 67

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



59
60
61
62
63
64
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 59

def self.optionals
  %w[
    bot_id
    is_enterprise_install
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



128
129
130
131
132
133
134
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 128

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} bot_id: #{@bot_id.inspect}, is_enterprise_install:"\
  " #{@is_enterprise_install.inspect}, ok: #{@ok.inspect}, team: #{@team.inspect}, team_id:"\
  " #{@team_id.inspect}, url: #{@url.inspect}, user: #{@user.inspect}, user_id:"\
  " #{@user_id.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



120
121
122
123
124
125
 
# File 'lib/slack_web_api/models/auth_test_success_schema.rb', line 120

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} bot_id: #{@bot_id}, is_enterprise_install: #{@is_enterprise_install}, ok:"\
  " #{@ok}, team: #{@team}, team_id: #{@team_id}, url: #{@url}, user: #{@user}, user_id:"\
  " #{@user_id}, additional_properties: #{@additional_properties}>"
end