slack-ruby-client 1.0.0 → 2.1.0

data/bin/commands/apps.rb

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Apps methods.'
-command 'apps' do |g|
-  g.desc 'Uninstalls your app from a workspace.'
-  g.long_desc %( Uninstalls your app from a workspace. )
-  g.command 'uninstall' do |c|
-    c.flag 'client_id', desc: 'Issued when you created your application.'
-    c.flag 'client_secret', desc: 'Issued when you created your application.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_uninstall(options))
+module Slack
+  module Cli
+    class App
+      desc 'Apps methods.'
+      command 'apps' do |g|
+        g.desc 'Uninstalls your app from a workspace.'
+        g.long_desc %( Uninstalls your app from a workspace. )
+        g.command 'uninstall' do |c|
+          c.flag 'client_id', desc: 'Issued when you created your application.'
+          c.flag 'client_secret', desc: 'Issued when you created your application.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_uninstall(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/apps_connections.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'AppsConnections methods.'
-command 'apps_connections' do |g|
-  g.desc 'Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over,'
-  g.long_desc %( Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over, )
-  g.command 'open' do |c|
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_connections_open(options))
+module Slack
+  module Cli
+    class App
+      desc 'AppsConnections methods.'
+      command 'apps_connections' do |g|
+        g.desc 'Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over.'
+        g.long_desc %( Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over. )
+        g.command 'open' do |c|
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_connections_open(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/apps_event_authorizations.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'AppsEventAuthorizations methods.'
-command 'apps_event_authorizations' do |g|
-  g.desc 'Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.'
-  g.long_desc %( Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. )
-  g.command 'list' do |c|
-    c.flag 'event_context', desc: '.'
-    c.flag 'cursor', desc: '.'
-    c.flag 'limit', desc: '.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_event_authorizations_list(options))
+module Slack
+  module Cli
+    class App
+      desc 'AppsEventAuthorizations methods.'
+      command 'apps_event_authorizations' do |g|
+        g.desc 'Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.'
+        g.long_desc %( Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. )
+        g.command 'list' do |c|
+          c.flag 'event_context', desc: '.'
+          c.flag 'cursor', desc: '.'
+          c.flag 'limit', desc: '.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_event_authorizations_list(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/apps_manifest.rb

@@ -1,51 +1,58 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'AppsManifest methods.'
-command 'apps_manifest' do |g|
-  g.desc 'Create an app from an app manifest.'
-  g.long_desc %( Create an app from an app manifest. )
-  g.command 'create' do |c|
-    c.flag 'manifest', desc: 'A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_manifest_create(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'AppsManifest methods.'
+      command 'apps_manifest' do |g|
+        g.desc 'Create an app from an app manifest.'
+        g.long_desc %( Create an app from an app manifest. )
+        g.command 'create' do |c|
+          c.flag 'manifest', desc: 'A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_manifest_create(options))
+          end
+        end
 
-  g.desc 'Permanently deletes an app created through app manifests'
-  g.long_desc %( Permanently deletes an app created through app manifests )
-  g.command 'delete' do |c|
-    c.flag 'app_id', desc: 'The ID of the app you want to delete.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_manifest_delete(options))
-    end
-  end
+        g.desc 'Permanently deletes an app created through app manifests'
+        g.long_desc %( Permanently deletes an app created through app manifests )
+        g.command 'delete' do |c|
+          c.flag 'app_id', desc: 'The ID of the app you want to delete.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_manifest_delete(options))
+          end
+        end
 
-  g.desc 'Export an app manifest from an existing app'
-  g.long_desc %( Export an app manifest from an existing app )
-  g.command 'export' do |c|
-    c.flag 'app_id', desc: 'The ID of the app whose configuration you want to export as a manifest.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_manifest_export(options))
-    end
-  end
+        g.desc 'Export an app manifest from an existing app'
+        g.long_desc %( Export an app manifest from an existing app )
+        g.command 'export' do |c|
+          c.flag 'app_id', desc: 'The ID of the app whose configuration you want to export as a manifest.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_manifest_export(options))
+          end
+        end
 
-  g.desc 'Update an app from an app manifest'
-  g.long_desc %( Update an app from an app manifest )
-  g.command 'update' do |c|
-    c.flag 'app_id', desc: 'The ID of the app whose configuration you want to update.'
-    c.flag 'manifest', desc: 'A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one. As this method entirely replaces any previous configuration, manifest must contain both unmodified and modified fields.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_manifest_update(options))
-    end
-  end
+        g.desc 'Update an app from an app manifest'
+        g.long_desc %( Update an app from an app manifest )
+        g.command 'update' do |c|
+          c.flag 'app_id', desc: 'The ID of the app whose configuration you want to update.'
+          c.flag 'manifest', desc: 'A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one. As this method entirely replaces any previous configuration, manifest must contain both unmodified and modified fields.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_manifest_update(options))
+          end
+        end
 
-  g.desc 'Validate an app manifest'
-  g.long_desc %( Validate an app manifest )
-  g.command 'validate' do |c|
-    c.flag 'manifest', desc: 'The manifest to be validated. Will be validated against the app manifest schema - read our guide.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.apps_manifest_validate(options))
+        g.desc 'Validate an app manifest'
+        g.long_desc %( Validate an app manifest )
+        g.command 'validate' do |c|
+          c.flag 'manifest', desc: 'The manifest to be validated. Will be validated against the app manifest schema - read our guide.'
+          c.flag 'app_id', desc: 'The ID of the app whose configuration you want to validate.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.apps_manifest_validate(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/auth.rb

@@ -1,22 +1,28 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Auth methods.'
-command 'auth' do |g|
-  g.desc 'Revokes a token.'
-  g.long_desc %( Revokes a token. )
-  g.command 'revoke' do |c|
-    c.flag 'test', desc: 'Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.auth_revoke(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'Auth methods.'
+      command 'auth' do |g|
+        g.desc 'Revokes a token.'
+        g.long_desc %( Revokes a token. )
+        g.command 'revoke' do |c|
+          c.flag 'test', desc: 'Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.auth_revoke(options))
+          end
+        end
 
-  g.desc 'Checks authentication & identity.'
-  g.long_desc %( Checks authentication & identity. )
-  g.command 'test' do |c|
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.auth_test(options))
+        g.desc 'Checks authentication & identity.'
+        g.long_desc %( Checks authentication & identity. )
+        g.command 'test' do |c|
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.auth_test(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/auth_teams.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'AuthTeams methods.'
-command 'auth_teams' do |g|
-  g.desc 'List the workspaces a token can access.'
-  g.long_desc %( List the workspaces a token can access. )
-  g.command 'list' do |c|
-    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
-    c.flag 'include_icon', desc: 'Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.'
-    c.flag 'limit', desc: 'The maximum number of workspaces to return. Must be a positive integer no larger than 1000.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.auth_teams_list(options))
+module Slack
+  module Cli
+    class App
+      desc 'AuthTeams methods.'
+      command 'auth_teams' do |g|
+        g.desc 'List the workspaces a token can access.'
+        g.long_desc %( List the workspaces a token can access. )
+        g.command 'list' do |c|
+          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+          c.flag 'include_icon', desc: 'Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.'
+          c.flag 'limit', desc: 'The maximum number of workspaces to return. Must be a positive integer no larger than 1000.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.auth_teams_list(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/bookmarks.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'Bookmarks methods.'
+      command 'bookmarks' do |g|
+        g.desc 'Add bookmark to a channel.'
+        g.long_desc %( Add bookmark to a channel. )
+        g.command 'add' do |c|
+          c.flag 'channel_id', desc: 'Channel to add bookmark in.'
+          c.flag 'title', desc: 'Title for the bookmark.'
+          c.flag 'type', desc: 'Type of the bookmark i.e link.'
+          c.flag 'emoji', desc: 'Emoji tag to apply to the link.'
+          c.flag 'entity_id', desc: 'ID of the entity being bookmarked. Only applies to message and file types.'
+          c.flag 'link', desc: 'Link to bookmark.'
+          c.flag 'parent_id', desc: "Id of this bookmark's parent."
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.bookmarks_add(options))
+          end
+        end
+
+        g.desc 'Edit bookmark.'
+        g.long_desc %( Edit bookmark. )
+        g.command 'edit' do |c|
+          c.flag 'bookmark_id', desc: 'Bookmark to update.'
+          c.flag 'channel_id', desc: 'Channel to update bookmark in.'
+          c.flag 'emoji', desc: 'Emoji tag to apply to the link.'
+          c.flag 'link', desc: 'Link to bookmark.'
+          c.flag 'title', desc: 'Title for the bookmark.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.bookmarks_edit(options))
+          end
+        end
+
+        g.desc 'List bookmark for the channel.'
+        g.long_desc %( List bookmark for the channel. )
+        g.command 'list' do |c|
+          c.flag 'channel_id', desc: 'Channel to list bookmarks in.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.bookmarks_list(options))
+          end
+        end
+
+        g.desc 'Remove bookmark from the channel.'
+        g.long_desc %( Remove bookmark from the channel. )
+        g.command 'remove' do |c|
+          c.flag 'bookmark_id', desc: 'Bookmark to remove.'
+          c.flag 'channel_id', desc: 'Channel to remove bookmark.'
+          c.flag 'quip_section_id', desc: 'Quip section ID to unbookmark.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.bookmarks_remove(options))
+          end
+        end
+      end
+    end
+  end
+end

data/bin/commands/bots.rb

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Bots methods.'
-command 'bots' do |g|
-  g.desc 'Gets information about a bot user.'
-  g.long_desc %( Gets information about a bot user. )
-  g.command 'info' do |c|
-    c.flag 'bot', desc: 'Bot user to get info on.'
-    c.flag 'team_id', desc: 'encoded team id or enterprise id where the bot exists, required if org token is used.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.bots_info(options))
+module Slack
+  module Cli
+    class App
+      desc 'Bots methods.'
+      command 'bots' do |g|
+        g.desc 'Gets information about a bot user.'
+        g.long_desc %( Gets information about a bot user. )
+        g.command 'info' do |c|
+          c.flag 'bot', desc: 'Bot user to get info on.'
+          c.flag 'team_id', desc: 'encoded team id or enterprise id where the bot exists, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.bots_info(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/calls.rb

@@ -1,52 +1,58 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Calls methods.'
-command 'calls' do |g|
-  g.desc 'Registers a new Call.'
-  g.long_desc %( Registers a new Call. )
-  g.command 'add' do |c|
-    c.flag 'external_unique_id', desc: 'An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.'
-    c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
-    c.flag 'created_by', desc: 'The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.'
-    c.flag 'date_start', desc: 'Call start time in UTC UNIX timestamp format.'
-    c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
-    c.flag 'external_display_id', desc: 'An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.'
-    c.flag 'title', desc: 'The name of the Call.'
-    c.flag 'users', desc: 'The list of users to register as participants in the Call. Read more on how to specify users here.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.calls_add(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'Calls methods.'
+      command 'calls' do |g|
+        g.desc 'Registers a new Call.'
+        g.long_desc %( Registers a new Call. )
+        g.command 'add' do |c|
+          c.flag 'external_unique_id', desc: 'An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.'
+          c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
+          c.flag 'created_by', desc: 'The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.'
+          c.flag 'date_start', desc: 'Call start time in UTC UNIX timestamp format.'
+          c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
+          c.flag 'external_display_id', desc: 'An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.'
+          c.flag 'title', desc: 'The name of the Call.'
+          c.flag 'users', desc: 'The list of users to register as participants in the Call. Read more on how to specify users here.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.calls_add(options))
+          end
+        end
 
-  g.desc 'Ends a Call.'
-  g.long_desc %( Ends a Call. )
-  g.command 'end' do |c|
-    c.flag 'id', desc: 'id returned when registering the call using the calls.add method.'
-    c.flag 'duration', desc: 'Call duration in seconds.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.calls_end(options))
-    end
-  end
+        g.desc 'Ends a Call.'
+        g.long_desc %( Ends a Call. )
+        g.command 'end' do |c|
+          c.flag 'id', desc: 'id returned when registering the call using the calls.add method.'
+          c.flag 'duration', desc: 'Call duration in seconds.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.calls_end(options))
+          end
+        end
 
-  g.desc 'Returns information about a Call.'
-  g.long_desc %( Returns information about a Call. )
-  g.command 'info' do |c|
-    c.flag 'id', desc: 'id of the Call returned by the calls.add method.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.calls_info(options))
-    end
-  end
+        g.desc 'Returns information about a Call.'
+        g.long_desc %( Returns information about a Call. )
+        g.command 'info' do |c|
+          c.flag 'id', desc: 'id of the Call returned by the calls.add method.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.calls_info(options))
+          end
+        end
 
-  g.desc 'Updates information about a Call.'
-  g.long_desc %( Updates information about a Call. )
-  g.command 'update' do |c|
-    c.flag 'id', desc: 'id returned by the calls.add method.'
-    c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
-    c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
-    c.flag 'title', desc: 'The name of the Call.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.calls_update(options))
+        g.desc 'Updates information about a Call.'
+        g.long_desc %( Updates information about a Call. )
+        g.command 'update' do |c|
+          c.flag 'id', desc: 'id returned by the calls.add method.'
+          c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
+          c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
+          c.flag 'title', desc: 'The name of the Call.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.calls_update(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/calls_participants.rb

@@ -1,25 +1,31 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'CallsParticipants methods.'
-command 'calls_participants' do |g|
-  g.desc 'Registers new participants added to a Call.'
-  g.long_desc %( Registers new participants added to a Call. )
-  g.command 'add' do |c|
-    c.flag 'id', desc: 'id returned by the calls.add method.'
-    c.flag 'users', desc: 'The list of users to add as participants in the Call. Read more on how to specify users here.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.calls_participants_add(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'CallsParticipants methods.'
+      command 'calls_participants' do |g|
+        g.desc 'Registers new participants added to a Call.'
+        g.long_desc %( Registers new participants added to a Call. )
+        g.command 'add' do |c|
+          c.flag 'id', desc: 'id returned by the calls.add method.'
+          c.flag 'users', desc: 'The list of users to add as participants in the Call. Read more on how to specify users here.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.calls_participants_add(options))
+          end
+        end
 
-  g.desc 'Registers participants removed from a Call.'
-  g.long_desc %( Registers participants removed from a Call. )
-  g.command 'remove' do |c|
-    c.flag 'id', desc: 'id returned by the calls.add method.'
-    c.flag 'users', desc: 'The list of users to remove as participants in the Call. Read more on how to specify users here.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.calls_participants_remove(options))
+        g.desc 'Registers participants removed from a Call.'
+        g.long_desc %( Registers participants removed from a Call. )
+        g.command 'remove' do |c|
+          c.flag 'id', desc: 'id returned by the calls.add method.'
+          c.flag 'users', desc: 'The list of users to remove as participants in the Call. Read more on how to specify users here.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.calls_participants_remove(options))
+          end
+        end
+      end
     end
   end
 end