Class: SlackWebApi::UsersProfileSetSchema

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

Overview

Schema for successful response from users.profile.set 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(profile:, username:, email_pending: SKIP, additional_properties: nil) ⇒ UsersProfileSetSchema

Returns a new instance of UsersProfileSetSchema.



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

def initialize(profile:, username:, email_pending: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @email_pending = email_pending unless email_pending == SKIP
  @ok = 'True'
  @profile = profile
  @username = username
  @additional_properties = additional_properties
end

Instance Attribute Details

#email_pending ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def email_pending
  @email_pending
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#profile ⇒ UserProfileObject

TODO: Write general description for this method

Returns:



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

def profile
  @profile
end

#username ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def username
  @username
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
 
# File 'lib/slack_web_api/models/users_profile_set_schema.rb', line 63

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  profile = UserProfileObject.from_hash(hash['profile']) if hash['profile']
  username = hash.key?('username') ? hash['username'] : nil
  email_pending = hash.key?('email_pending') ? hash['email_pending'] : 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.

  UsersProfileSetSchema.new(profile: profile,
                            username: username,
                            email_pending: email_pending,
                            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_profile_set_schema.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['email_pending'] = 'email_pending'
  @_hash['ok'] = 'ok'
  @_hash['profile'] = 'profile'
  @_hash['username'] = 'username'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



46
47
48
 
# File 'lib/slack_web_api/models/users_profile_set_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_profile_set_schema.rb', line 39

def self.optionals
  %w[
    email_pending
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



93
94
95
96
97
98
 
# File 'lib/slack_web_api/models/users_profile_set_schema.rb', line 93

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



86
87
88
89
90
 
# File 'lib/slack_web_api/models/users_profile_set_schema.rb', line 86

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