Class: SlackWebApi::StarsListSchema

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

Overview

Schema for successful response from stars.list 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(items:, paging: SKIP, additional_properties: nil) ⇒ StarsListSchema

Returns a new instance of StarsListSchema.



45
46
47
48
49
50
51
52
53
 
# File 'lib/slack_web_api/models/stars_list_schema.rb', line 45

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

  @items = items
  @ok = 'True'
  @paging = paging unless paging == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#items ⇒ Array[Object]

TODO: Write general description for this method

Returns:

  • (Array[Object]) 


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

def items
  @items
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#paging ⇒ PagingObject

TODO: Write general description for this method

Returns:



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

def paging
  @paging
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  items = hash.key?('items') ? hash['items'] : nil
  paging = PagingObject.from_hash(hash['paging']) if hash['paging']

  # 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.
  StarsListSchema.new(items: items,
                      paging: paging,
                      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/stars_list_schema.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/slack_web_api/models/stars_list_schema.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    paging
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
 
# File 'lib/slack_web_api/models/stars_list_schema.rb', line 84

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



77
78
79
80
81
 
# File 'lib/slack_web_api/models/stars_list_schema.rb', line 77

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