Class: SlackWebApi::ConversationsMembersSuccessSchema

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

Overview

Schema for successful response conversations.members 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(members:, response_metadata:, additional_properties: nil) ⇒ ConversationsMembersSuccessSchema

Returns a new instance of ConversationsMembersSuccessSchema.



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

def initialize(members:, response_metadata:, additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @members = members
  @ok = 'True'
  @response_metadata = response_metadata
  @additional_properties = additional_properties
end

Instance Attribute Details

#members ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


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

def members
  @members
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#response_metadata ⇒ ResponseMetadata

TODO: Write general description for this method

Returns:



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

def response_metadata
  @response_metadata
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/slack_web_api/models/conversations_members_success_schema.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  members = hash.key?('members') ? hash['members'] : 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.

  ConversationsMembersSuccessSchema.new(members: members,
                                        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/conversations_members_success_schema.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/slack_web_api/models/conversations_members_success_schema.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



83
84
85
86
87
 
# File 'lib/slack_web_api/models/conversations_members_success_schema.rb', line 83

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



76
77
78
79
80
 
# File 'lib/slack_web_api/models/conversations_members_success_schema.rb', line 76

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