Class: SlackWebApi::Bot

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

Overview

Bot 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(app_id:, deleted:, icons:, id:, name:, updated:, user_id: SKIP, additional_properties: nil) ⇒ Bot

Returns a new instance of Bot.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/slack_web_api/models/bot.rb', line 65

def initialize(app_id:, deleted:, icons:, id:, name:, updated:,
               user_id: SKIP, additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @app_id = app_id
  @deleted = deleted
  @icons = icons
  @id = id
  @name = name
  @updated = updated
  @user_id = user_id unless user_id == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#app_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def app_id
  @app_id
end

#deleted ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def deleted
  @deleted
end

#icons ⇒ Icons

TODO: Write general description for this method

Returns:



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

def icons
  @icons
end

#id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def id
  @id
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def name
  @name
end

#updated ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def updated
  @updated
end

#user_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def user_id
  @user_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/slack_web_api/models/bot.rb', line 81

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  app_id = hash.key?('app_id') ? hash['app_id'] : nil
  deleted = hash.key?('deleted') ? hash['deleted'] : nil
  icons = Icons.from_hash(hash['icons']) if hash['icons']
  id = hash.key?('id') ? hash['id'] : nil
  name = hash.key?('name') ? hash['name'] : nil
  updated = hash.key?('updated') ? hash['updated'] : nil
  user_id = hash.key?('user_id') ? hash['user_id'] : 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.

  Bot.new(app_id: app_id,
          deleted: deleted,
          icons: icons,
          id: id,
          name: name,
          updated: updated,
          user_id: user_id,
          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/slack_web_api/models/bot.rb', line 41

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['app_id'] = 'app_id'
  @_hash['deleted'] = 'deleted'
  @_hash['icons'] = 'icons'
  @_hash['id'] = 'id'
  @_hash['name'] = 'name'
  @_hash['updated'] = 'updated'
  @_hash['user_id'] = 'user_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



61
62
63
 
# File 'lib/slack_web_api/models/bot.rb', line 61

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
 
# File 'lib/slack_web_api/models/bot.rb', line 54

def self.optionals
  %w[
    user_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} app_id: #{@app_id.inspect}, deleted: #{@deleted.inspect}, icons:"\
  " #{@icons.inspect}, id: #{@id.inspect}, name: #{@name.inspect}, updated:"\
  " #{@updated.inspect}, user_id: #{@user_id.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} app_id: #{@app_id}, deleted: #{@deleted}, icons: #{@icons}, id: #{@id},"\
  " name: #{@name}, updated: #{@updated}, user_id: #{@user_id}, additional_properties:"\
  " #{@additional_properties}>"
end