Class: SlackWebApi::AdminConversationsGetTeamsSchema

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

Overview

Schema for successful response of admin.conversations.getTeams

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_ids:, response_metadata: SKIP, additional_properties: nil) ⇒ AdminConversationsGetTeamsSchema

Returns a new instance of AdminConversationsGetTeamsSchema.



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

def initialize(team_ids:, response_metadata: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @ok = 'True'
  @response_metadata = response_metadata unless response_metadata == SKIP
  @team_ids = team_ids
  @additional_properties = additional_properties
end

Instance Attribute Details

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#response_metadata ⇒ ResponseMetadata

TODO: Write general description for this method

Returns:



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

def response_metadata
  @response_metadata
end

#team_ids ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


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

def team_ids
  @team_ids
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/slack_web_api/models/admin_conversations_get_teams_schema.rb', line 57

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  team_ids = hash.key?('team_ids') ? hash['team_ids'] : nil
  response_metadata = ResponseMetadata.from_hash(hash['response_metadata']) if
    hash['response_metadata']

  # 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.
  AdminConversationsGetTeamsSchema.new(team_ids: team_ids,
                                       response_metadata: response_metadata,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/slack_web_api/models/admin_conversations_get_teams_schema.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['ok'] = 'ok'
  @_hash['response_metadata'] = 'response_metadata'
  @_hash['team_ids'] = 'team_ids'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/slack_web_api/models/admin_conversations_get_teams_schema.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
 
# File 'lib/slack_web_api/models/admin_conversations_get_teams_schema.rb', line 34

def self.optionals
  %w[
    response_metadata
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



86
87
88
89
90
 
# File 'lib/slack_web_api/models/admin_conversations_get_teams_schema.rb', line 86

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} ok: #{@ok.inspect}, response_metadata: #{@response_metadata.inspect},"\
  " team_ids: #{@team_ids.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



79
80
81
82
83
 
# File 'lib/slack_web_api/models/admin_conversations_get_teams_schema.rb', line 79

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} ok: #{@ok}, response_metadata: #{@response_metadata}, team_ids:"\
  " #{@team_ids}, additional_properties: #{@additional_properties}>"
end