Class: SlackWebApi::ConversationsCloseSuccessSchema

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

Overview

Schema for successful response conversations.close 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(already_closed: SKIP, no_op: SKIP, additional_properties: nil) ⇒ ConversationsCloseSuccessSchema

Returns a new instance of ConversationsCloseSuccessSchema.



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

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

  additional_properties = {} if additional_properties.nil?

  @already_closed = already_closed unless already_closed == SKIP
  @no_op = no_op unless no_op == SKIP
  @ok = 'True'
  @additional_properties = additional_properties
end

Instance Attribute Details

#already_closed ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def already_closed
  @already_closed
end

#no_op ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def no_op
  @no_op
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
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/conversations_close_success_schema.rb', line 58

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

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

  ConversationsCloseSuccessSchema.new(already_closed: already_closed,
                                      no_op: no_op,
                                      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_close_success_schema.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    already_closed
    no_op
  ]
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/conversations_close_success_schema.rb', line 87

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} already_closed: #{@already_closed.inspect}, no_op: #{@no_op.inspect}, ok:"\
  " #{@ok.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/conversations_close_success_schema.rb', line 80

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