Class: SlackWebApi::DndSetSnoozeSchema

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

Overview

Schema for successful response from dnd.setSnooze 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(snooze_enabled:, snooze_endtime:, snooze_remaining:, additional_properties: nil) ⇒ DndSetSnoozeSchema

Returns a new instance of DndSetSnoozeSchema.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/slack_web_api/models/dnd_set_snooze_schema.rb', line 48

def initialize(snooze_enabled:, snooze_endtime:, snooze_remaining:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @ok = 'True'
  @snooze_enabled = snooze_enabled
  @snooze_endtime = snooze_endtime
  @snooze_remaining = snooze_remaining
  @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/dnd_set_snooze_schema.rb', line 14

def ok
  @ok
end

#snooze_enabled ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def snooze_enabled
  @snooze_enabled
end

#snooze_endtime ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def snooze_endtime
  @snooze_endtime
end

#snooze_remaining ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/slack_web_api/models/dnd_set_snooze_schema.rb', line 26

def snooze_remaining
  @snooze_remaining
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/slack_web_api/models/dnd_set_snooze_schema.rb', line 61

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  snooze_enabled =
    hash.key?('snooze_enabled') ? hash['snooze_enabled'] : nil
  snooze_endtime =
    hash.key?('snooze_endtime') ? hash['snooze_endtime'] : nil
  snooze_remaining =
    hash.key?('snooze_remaining') ? hash['snooze_remaining'] : nil

  # 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.
  DndSetSnoozeSchema.new(snooze_enabled: snooze_enabled,
                         snooze_endtime: snooze_endtime,
                         snooze_remaining: snooze_remaining,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/slack_web_api/models/dnd_set_snooze_schema.rb', line 29

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

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/slack_web_api/models/dnd_set_snooze_schema.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



95
96
97
98
99
100
 
# File 'lib/slack_web_api/models/dnd_set_snooze_schema.rb', line 95

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

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