slackapi-sdk 1.0.0

data/lib/slack_web_api/models/oauth_scope.rb

@@ -0,0 +1,296 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # OAuth 2 scopes supported by the API
+  class OauthScope
+    OAUTH_SCOPE = [
+      # admin
+      ADMIN = 'admin'.freeze,
+
+      # admin.apps:read
+      ADMIN_APPSREAD = 'admin.apps:read'.freeze,
+
+      # admin.apps:write
+      ADMIN_APPSWRITE = 'admin.apps:write'.freeze,
+
+      # admin.conversations:read
+      ADMIN_CONVERSATIONSREAD = 'admin.conversations:read'.freeze,
+
+      # admin.conversations:write
+      ADMIN_CONVERSATIONSWRITE = 'admin.conversations:write'.freeze,
+
+      # admin.invites:read
+      ADMIN_INVITESREAD = 'admin.invites:read'.freeze,
+
+      # admin.invites:write
+      ADMIN_INVITESWRITE = 'admin.invites:write'.freeze,
+
+      # admin.teams:read
+      ADMIN_TEAMSREAD = 'admin.teams:read'.freeze,
+
+      # admin.teams:write
+      ADMIN_TEAMSWRITE = 'admin.teams:write'.freeze,
+
+      # admin.usergroups:read
+      ADMIN_USERGROUPSREAD = 'admin.usergroups:read'.freeze,
+
+      # admin.usergroups:write
+      ADMIN_USERGROUPSWRITE = 'admin.usergroups:write'.freeze,
+
+      # admin.users:read
+      ADMIN_USERSREAD = 'admin.users:read'.freeze,
+
+      # admin.users:write
+      ADMIN_USERSWRITE = 'admin.users:write'.freeze,
+
+      # authorizations:read
+      AUTHORIZATIONSREAD = 'authorizations:read'.freeze,
+
+      # Bot user scope
+      BOT = 'bot'.freeze,
+
+      # calls:read
+      CALLSREAD = 'calls:read'.freeze,
+
+      # calls:write
+      CALLSWRITE = 'calls:write'.freeze,
+
+      # channels:history
+      CHANNELSHISTORY = 'channels:history'.freeze,
+
+      # channels:manage
+      CHANNELSMANAGE = 'channels:manage'.freeze,
+
+      # channels:read
+      CHANNELSREAD = 'channels:read'.freeze,
+
+      # channels:write
+      CHANNELSWRITE = 'channels:write'.freeze,
+
+      # chat:write
+      CHATWRITE = 'chat:write'.freeze,
+
+      # Author messages as a bot
+      CHATWRITEBOT = 'chat:write:bot'.freeze,
+
+      # Author messages as a user
+      CHATWRITEUSER = 'chat:write:user'.freeze,
+
+      # conversations:history
+      CONVERSATIONSHISTORY = 'conversations:history'.freeze,
+
+      # conversations:read
+      CONVERSATIONSREAD = 'conversations:read'.freeze,
+
+      # conversations:write
+      CONVERSATIONSWRITE = 'conversations:write'.freeze,
+
+      # dnd:read
+      DNDREAD = 'dnd:read'.freeze,
+
+      # dnd:write
+      DNDWRITE = 'dnd:write'.freeze,
+
+      # emoji:read
+      EMOJIREAD = 'emoji:read'.freeze,
+
+      # files:read
+      FILESREAD = 'files:read'.freeze,
+
+      # files:write:user
+      FILESWRITEUSER = 'files:write:user'.freeze,
+
+      # groups:history
+      GROUPSHISTORY = 'groups:history'.freeze,
+
+      # groups:read
+      GROUPSREAD = 'groups:read'.freeze,
+
+      # groups:write
+      GROUPSWRITE = 'groups:write'.freeze,
+
+      # identity.basic
+      IDENTITY_BASIC = 'identity.basic'.freeze,
+
+      # im:history
+      IMHISTORY = 'im:history'.freeze,
+
+      # im:read
+      IMREAD = 'im:read'.freeze,
+
+      # im:write
+      IMWRITE = 'im:write'.freeze,
+
+      # links:write
+      LINKSWRITE = 'links:write'.freeze,
+
+      # mpim:history
+      MPIMHISTORY = 'mpim:history'.freeze,
+
+      # mpim:read
+      MPIMREAD = 'mpim:read'.freeze,
+
+      # mpim:write
+      MPIMWRITE = 'mpim:write'.freeze,
+
+      # No scope required
+      NONE = 'none'.freeze,
+
+      # pins:read
+      PINSREAD = 'pins:read'.freeze,
+
+      # pins:write
+      PINSWRITE = 'pins:write'.freeze,
+
+      # reactions:read
+      REACTIONSREAD = 'reactions:read'.freeze,
+
+      # reactions:write
+      REACTIONSWRITE = 'reactions:write'.freeze,
+
+      # reminders:read
+      REMINDERSREAD = 'reminders:read'.freeze,
+
+      # reminders:write
+      REMINDERSWRITE = 'reminders:write'.freeze,
+
+      # remote_files:read
+      REMOTE_FILESREAD = 'remote_files:read'.freeze,
+
+      # remote_files:share
+      REMOTE_FILESSHARE = 'remote_files:share'.freeze,
+
+      # remote_files:write
+      REMOTE_FILESWRITE = 'remote_files:write'.freeze,
+
+      # rtm:stream
+      RTMSTREAM = 'rtm:stream'.freeze,
+
+      # search:read
+      SEARCHREAD = 'search:read'.freeze,
+
+      # stars:read
+      STARSREAD = 'stars:read'.freeze,
+
+      # stars:write
+      STARSWRITE = 'stars:write'.freeze,
+
+      # team:read
+      TEAMREAD = 'team:read'.freeze,
+
+      # tokens.basic
+      TOKENS_BASIC = 'tokens.basic'.freeze,
+
+      # usergroups:read
+      USERGROUPSREAD = 'usergroups:read'.freeze,
+
+      # usergroups:write
+      USERGROUPSWRITE = 'usergroups:write'.freeze,
+
+      # users.profile:read
+      USERS_PROFILEREAD = 'users.profile:read'.freeze,
+
+      # users.profile:write
+      USERS_PROFILEWRITE = 'users.profile:write'.freeze,
+
+      # users:read
+      USERSREAD = 'users:read'.freeze,
+
+      # users:read.email
+      USERSREAD_EMAIL = 'users:read.email'.freeze,
+
+      # users:write
+      USERSWRITE = 'users:write'.freeze,
+
+      # workflow.steps:execute
+      WORKFLOW_STEPSEXECUTE = 'workflow.steps:execute'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_SCOPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ADMIN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'admin' then ADMIN
+      when 'admin_appsread' then ADMIN_APPSREAD
+      when 'admin_appswrite' then ADMIN_APPSWRITE
+      when 'admin_conversationsread' then ADMIN_CONVERSATIONSREAD
+      when 'admin_conversationswrite' then ADMIN_CONVERSATIONSWRITE
+      when 'admin_invitesread' then ADMIN_INVITESREAD
+      when 'admin_inviteswrite' then ADMIN_INVITESWRITE
+      when 'admin_teamsread' then ADMIN_TEAMSREAD
+      when 'admin_teamswrite' then ADMIN_TEAMSWRITE
+      when 'admin_usergroupsread' then ADMIN_USERGROUPSREAD
+      when 'admin_usergroupswrite' then ADMIN_USERGROUPSWRITE
+      when 'admin_usersread' then ADMIN_USERSREAD
+      when 'admin_userswrite' then ADMIN_USERSWRITE
+      when 'authorizationsread' then AUTHORIZATIONSREAD
+      when 'bot' then BOT
+      when 'callsread' then CALLSREAD
+      when 'callswrite' then CALLSWRITE
+      when 'channelshistory' then CHANNELSHISTORY
+      when 'channelsmanage' then CHANNELSMANAGE
+      when 'channelsread' then CHANNELSREAD
+      when 'channelswrite' then CHANNELSWRITE
+      when 'chatwrite' then CHATWRITE
+      when 'chatwritebot' then CHATWRITEBOT
+      when 'chatwriteuser' then CHATWRITEUSER
+      when 'conversationshistory' then CONVERSATIONSHISTORY
+      when 'conversationsread' then CONVERSATIONSREAD
+      when 'conversationswrite' then CONVERSATIONSWRITE
+      when 'dndread' then DNDREAD
+      when 'dndwrite' then DNDWRITE
+      when 'emojiread' then EMOJIREAD
+      when 'filesread' then FILESREAD
+      when 'fileswriteuser' then FILESWRITEUSER
+      when 'groupshistory' then GROUPSHISTORY
+      when 'groupsread' then GROUPSREAD
+      when 'groupswrite' then GROUPSWRITE
+      when 'identity_basic' then IDENTITY_BASIC
+      when 'imhistory' then IMHISTORY
+      when 'imread' then IMREAD
+      when 'imwrite' then IMWRITE
+      when 'linkswrite' then LINKSWRITE
+      when 'mpimhistory' then MPIMHISTORY
+      when 'mpimread' then MPIMREAD
+      when 'mpimwrite' then MPIMWRITE
+      when 'none' then NONE
+      when 'pinsread' then PINSREAD
+      when 'pinswrite' then PINSWRITE
+      when 'reactionsread' then REACTIONSREAD
+      when 'reactionswrite' then REACTIONSWRITE
+      when 'remindersread' then REMINDERSREAD
+      when 'reminderswrite' then REMINDERSWRITE
+      when 'remote_filesread' then REMOTE_FILESREAD
+      when 'remote_filesshare' then REMOTE_FILESSHARE
+      when 'remote_fileswrite' then REMOTE_FILESWRITE
+      when 'rtmstream' then RTMSTREAM
+      when 'searchread' then SEARCHREAD
+      when 'starsread' then STARSREAD
+      when 'starswrite' then STARSWRITE
+      when 'teamread' then TEAMREAD
+      when 'tokens_basic' then TOKENS_BASIC
+      when 'usergroupsread' then USERGROUPSREAD
+      when 'usergroupswrite' then USERGROUPSWRITE
+      when 'users_profileread' then USERS_PROFILEREAD
+      when 'users_profilewrite' then USERS_PROFILEWRITE
+      when 'usersread' then USERSREAD
+      when 'usersread_email' then USERSREAD_EMAIL
+      when 'userswrite' then USERSWRITE
+      when 'workflow_stepsexecute' then WORKFLOW_STEPSEXECUTE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/slack_web_api/models/oauth_token.rb

@@ -0,0 +1,96 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # OAuth 2 Authorization endpoint response
+  class OauthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, token_type:, expires_in: SKIP, scope: SKIP,
+                   expiry: SKIP, refresh_token: SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OauthToken.new(access_token: access_token,
+                     token_type: token_type,
+                     expires_in: expires_in,
+                     scope: scope,
+                     expiry: expiry,
+                     refresh_token: refresh_token)
+    end
+  end
+end

data/lib/slack_web_api/models/objs_enterprise_user.rb

@@ -0,0 +1,119 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # ObjsEnterpriseUser Model.
+  class ObjsEnterpriseUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :enterprise_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :enterprise_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_admin
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_owner
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :teams
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['enterprise_id'] = 'enterprise_id'
+      @_hash['enterprise_name'] = 'enterprise_name'
+      @_hash['id'] = 'id'
+      @_hash['is_admin'] = 'is_admin'
+      @_hash['is_owner'] = 'is_owner'
+      @_hash['teams'] = 'teams'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(enterprise_id:, enterprise_name:, id:, is_admin:, is_owner:,
+                   teams:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @enterprise_id = enterprise_id
+      @enterprise_name = enterprise_name
+      @id = id
+      @is_admin = is_admin
+      @is_owner = is_owner
+      @teams = teams
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      enterprise_id = hash.key?('enterprise_id') ? hash['enterprise_id'] : nil
+      enterprise_name =
+        hash.key?('enterprise_name') ? hash['enterprise_name'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      is_admin = hash.key?('is_admin') ? hash['is_admin'] : nil
+      is_owner = hash.key?('is_owner') ? hash['is_owner'] : nil
+      teams = hash.key?('teams') ? hash['teams'] : 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.
+      ObjsEnterpriseUser.new(enterprise_id: enterprise_id,
+                             enterprise_name: enterprise_name,
+                             id: id,
+                             is_admin: is_admin,
+                             is_owner: is_owner,
+                             teams: teams,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} enterprise_id: #{@enterprise_id}, enterprise_name: #{@enterprise_name}, id:"\
+      " #{@id}, is_admin: #{@is_admin}, is_owner: #{@is_owner}, teams: #{@teams},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} enterprise_id: #{@enterprise_id.inspect}, enterprise_name:"\
+      " #{@enterprise_name.inspect}, id: #{@id.inspect}, is_admin: #{@is_admin.inspect}, is_owner:"\
+      " #{@is_owner.inspect}, teams: #{@teams.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/slack_web_api/models/objs_icon.rb

@@ -0,0 +1,147 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # ObjsIcon Model.
+  class ObjsIcon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_102
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_132
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_230
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_34
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_44
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_68
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_88
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :image_default
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['image_102'] = 'image_102'
+      @_hash['image_132'] = 'image_132'
+      @_hash['image_230'] = 'image_230'
+      @_hash['image_34'] = 'image_34'
+      @_hash['image_44'] = 'image_44'
+      @_hash['image_68'] = 'image_68'
+      @_hash['image_88'] = 'image_88'
+      @_hash['image_default'] = 'image_default'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        image_102
+        image_132
+        image_230
+        image_34
+        image_44
+        image_68
+        image_88
+        image_default
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(image_102: SKIP, image_132: SKIP, image_230: SKIP,
+                   image_34: SKIP, image_44: SKIP, image_68: SKIP,
+                   image_88: SKIP, image_default: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @image_102 = image_102 unless image_102 == SKIP
+      @image_132 = image_132 unless image_132 == SKIP
+      @image_230 = image_230 unless image_230 == SKIP
+      @image_34 = image_34 unless image_34 == SKIP
+      @image_44 = image_44 unless image_44 == SKIP
+      @image_68 = image_68 unless image_68 == SKIP
+      @image_88 = image_88 unless image_88 == SKIP
+      @image_default = image_default unless image_default == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      image_102 = hash.key?('image_102') ? hash['image_102'] : SKIP
+      image_132 = hash.key?('image_132') ? hash['image_132'] : SKIP
+      image_230 = hash.key?('image_230') ? hash['image_230'] : SKIP
+      image_34 = hash.key?('image_34') ? hash['image_34'] : SKIP
+      image_44 = hash.key?('image_44') ? hash['image_44'] : SKIP
+      image_68 = hash.key?('image_68') ? hash['image_68'] : SKIP
+      image_88 = hash.key?('image_88') ? hash['image_88'] : SKIP
+      image_default = hash.key?('image_default') ? hash['image_default'] : 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.
+      ObjsIcon.new(image_102: image_102,
+                   image_132: image_132,
+                   image_230: image_230,
+                   image_34: image_34,
+                   image_44: image_44,
+                   image_68: image_68,
+                   image_88: image_88,
+                   image_default: image_default,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} image_102: #{@image_102}, image_132: #{@image_132}, image_230:"\
+      " #{@image_230}, image_34: #{@image_34}, image_44: #{@image_44}, image_68: #{@image_68},"\
+      " image_88: #{@image_88}, image_default: #{@image_default}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} image_102: #{@image_102.inspect}, image_132: #{@image_132.inspect},"\
+      " image_230: #{@image_230.inspect}, image_34: #{@image_34.inspect}, image_44:"\
+      " #{@image_44.inspect}, image_68: #{@image_68.inspect}, image_88: #{@image_88.inspect},"\
+      " image_default: #{@image_default.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end