Class: SlackWebApi::UsersConversationsSuccessSchema

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

Overview

Schema for successful response from users.conversations method. Returned conversation objects do not include num_members or is_member

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(channels:, response_metadata: SKIP, additional_properties: nil) ⇒ UsersConversationsSuccessSchema

Returns a new instance of UsersConversationsSuccessSchema.



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

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

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

Instance Attribute Details

#channels ⇒ Array[Object]

TODO: Write general description for this method

Returns:

  • (Array[Object]) 


15
16
17
 
# File 'lib/slack_web_api/models/users_conversations_success_schema.rb', line 15

def channels
  @channels
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


19
20
21
 
# File 'lib/slack_web_api/models/users_conversations_success_schema.rb', line 19

def ok
  @ok
end

#response_metadata ⇒ ResponseMetadata

TODO: Write general description for this method

Returns:



23
24
25
 
# File 'lib/slack_web_api/models/users_conversations_success_schema.rb', line 23

def response_metadata
  @response_metadata
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  channels = hash.key?('channels') ? hash['channels'] : 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.
  UsersConversationsSuccessSchema.new(channels: channels,
                                      response_metadata: response_metadata,
                                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
38
39
 
# File 'lib/slack_web_api/models/users_conversations_success_schema.rb', line 35

def self.optionals
  %w[
    response_metadata
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



87
88
89
90
91
 
# File 'lib/slack_web_api/models/users_conversations_success_schema.rb', line 87

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} channels: #{@channels.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.



80
81
82
83
84
 
# File 'lib/slack_web_api/models/users_conversations_success_schema.rb', line 80

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