Class: SlackWebApi::AdminConversationsCreateSchema

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

Overview

Schema for successful response of admin.conversations.create

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(channel_id: SKIP, additional_properties: nil) ⇒ AdminConversationsCreateSchema

Returns a new instance of AdminConversationsCreateSchema.



40
41
42
43
44
45
46
47
 
# File 'lib/slack_web_api/models/admin_conversations_create_schema.rb', line 40

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

  additional_properties = {} if additional_properties.nil?

  @channel_id = channel_id unless channel_id == SKIP
  @ok = 'True'
  @additional_properties = additional_properties
end

Instance Attribute Details

#channel_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def channel_id
  @channel_id
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/slack_web_api/models/admin_conversations_create_schema.rb', line 50

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  channel_id = hash.key?('channel_id') ? hash['channel_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.

  AdminConversationsCreateSchema.new(channel_id: channel_id,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/slack_web_api/models/admin_conversations_create_schema.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



36
37
38
 
# File 'lib/slack_web_api/models/admin_conversations_create_schema.rb', line 36

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
 
# File 'lib/slack_web_api/models/admin_conversations_create_schema.rb', line 29

def self.optionals
  %w[
    channel_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



69
70
71
72
73
 
# File 'lib/slack_web_api/models/admin_conversations_create_schema.rb', line 69

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