Class: SlackWebApi::AppsPermissionsResourcesListSuccessSchema

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

Overview

Schema for successful response apps.permissions.resources.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(resources:, response_metadata: SKIP, additional_properties: nil) ⇒ AppsPermissionsResourcesListSuccessSchema

Returns a new instance of AppsPermissionsResourcesListSuccessSchema.



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

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

  additional_properties = {} if additional_properties.nil?

  @ok = 'True'
  @resources = resources
  @response_metadata = response_metadata unless response_metadata == SKIP
  @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/apps_permissions_resources_list_success_schema.rb', line 14

def ok
  @ok
end

#resources ⇒ Array[Resource]

TODO: Write general description for this method

Returns:



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

def resources
  @resources
end

#response_metadata ⇒ ResponseMetadata

TODO: Write general description for this method

Returns:



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

def response_metadata
  @response_metadata
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  # Parameter is an array, so we need to iterate through it

  resources = nil
  unless hash['resources'].nil?
    resources = []
    hash['resources'].each do |structure|
      resources << (Resource.from_hash(structure) if structure)
    end
  end

  resources = nil unless hash.key?('resources')
  response_metadata = ResponseMetadata.from_hash(hash['response_metadata']) if
    hash['response_metadata']

  # 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.

  AppsPermissionsResourcesListSuccessSchema.new(resources: resources,
                                                response_metadata: response_metadata,
                                                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/apps_permissions_resources_list_success_schema.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/slack_web_api/models/apps_permissions_resources_list_success_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/apps_permissions_resources_list_success_schema.rb', line 34

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
 
# File 'lib/slack_web_api/models/apps_permissions_resources_list_success_schema.rb', line 95

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

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