Class: SlackWebApi::UsersListSchema

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

Overview

Schema for successful response from users.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(cache_ts:, members:, response_metadata: SKIP, additional_properties: nil) ⇒ UsersListSchema 



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/slack_web_api/models/users_list_schema.rb', line 50

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

  additional_properties = {} if additional_properties.nil?

  @cache_ts = cache_ts
  @members = members
  @ok = 'True'
  @response_metadata = response_metadata unless response_metadata == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#cache_ts ⇒ Integer

TODO: Write general description for this method



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

def cache_ts
  @cache_ts
end

#members ⇒ Array[Object]

TODO: Write general description for this method



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

def members
  @members
end

#ok ⇒ String (readonly)

TODO: Write general description for this method



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

def ok
  @ok
end

#response_metadata ⇒ Object

TODO: Write general description for this method



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

def response_metadata
  @response_metadata
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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/users_list_schema.rb', line 63

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  cache_ts = hash.key?('cache_ts') ? hash['cache_ts'] : nil
  members = hash.key?('members') ? hash['members'] : nil
  response_metadata =
    hash.key?('response_metadata') ? hash['response_metadata'] : 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.

  UsersListSchema.new(cache_ts: cache_ts,
                      members: members,
                      response_metadata: response_metadata,
                      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/users_list_schema.rb', line 29

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

.nullables ⇒ Object

An array for nullable fields



46
47
48
 
# File 'lib/slack_web_api/models/users_list_schema.rb', line 46

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
 
# File 'lib/slack_web_api/models/users_list_schema.rb', line 39

def self.optionals
  %w[
    response_metadata
  ]
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/users_list_schema.rb', line 95

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



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

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