From f171d0592ca1ae68b02b34dbbebeac38b3a49b81 Mon Sep 17 00:00:00 2001 From: slack-ruby-ci-bot Date: Sun, 3 Sep 2023 23:19:02 +0000 Subject: [PATCH] Update API from slack-api-ref@f2e768a (2023-09-03) --- bin/commands/admin_apps_activities.rb | 6 +++--- bin/commands/admin_users.rb | 2 +- bin/commands/dnd.rb | 2 +- lib/slack/web/api/endpoints/admin_apps_activities.rb | 6 +++--- lib/slack/web/api/endpoints/admin_users.rb | 2 +- lib/slack/web/api/endpoints/dnd.rb | 2 +- lib/slack/web/api/slack-api-ref | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/bin/commands/admin_apps_activities.rb b/bin/commands/admin_apps_activities.rb index 65cd0e18..4a4da63a 100644 --- a/bin/commands/admin_apps_activities.rb +++ b/bin/commands/admin_apps_activities.rb @@ -9,8 +9,8 @@ class App g.desc 'Get logs for a specified team/org' g.long_desc %( Get logs for a specified team/org ) g.command 'list' do |c| - c.flag 'app_id', desc: 'The id of the app to get activities from.' - c.flag 'component_id', desc: "The component id of log events to be returned. Will be 'FnXXXXXX' for functions, and 'WfXXXXXX' for worflows." + c.flag 'app_id', desc: 'The ID of the app to get activities from.' + c.flag 'component_id', desc: "The component ID of log events to be returned. Will be 'FnXXXXXX' for functions, and 'WfXXXXXX' for worflows." c.flag 'component_type', desc: "The component type of log events to be returned. Acceptable values are ('events_api', 'workflows', 'functions', 'tables')." c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. See pagination for more detail." c.flag 'limit', desc: 'The maximum number of items to return.' @@ -21,7 +21,7 @@ class App c.flag 'sort_direction', desc: 'The direction you want the data sorted by (always by timestamp).' c.flag 'source', desc: "The source of log events to be returned. Acceptable values are ('slack', 'developer')." c.flag 'team_id', desc: 'The team who owns this log.' - c.flag 'trace_id', desc: 'The trace id of log events to be returned.' + c.flag 'trace_id', desc: 'The trace ID of log events to be returned.' c.action do |_global_options, options, _args| puts JSON.dump(@client.admin_apps_activities_list(options)) end diff --git a/bin/commands/admin_users.rb b/bin/commands/admin_users.rb index 4515cbbb..a3a50ec1 100644 --- a/bin/commands/admin_users.rb +++ b/bin/commands/admin_users.rb @@ -71,7 +71,7 @@ class App g.desc 'Set an expiration for a guest user' g.long_desc %( Set an expiration for a guest user ) g.command 'setExpiration' do |c| - c.flag 'expiration_ts', desc: 'Timestamp when guest account should be disabled.' + c.flag 'expiration_ts', desc: 'Epoch timestamp in seconds when guest account should be disabled.' c.flag 'user_id', desc: 'The ID of the user to set an expiration for.' c.flag 'team_id', desc: 'The ID (T1234) of the workspace.' c.action do |_global_options, options, _args| diff --git a/bin/commands/dnd.rb b/bin/commands/dnd.rb index 41f904a6..6c00aaa0 100644 --- a/bin/commands/dnd.rb +++ b/bin/commands/dnd.rb @@ -35,7 +35,7 @@ class App g.desc 'Turns on Do Not Disturb mode for the current user, or changes its duration.' g.long_desc %( Turns on Do Not Disturb mode for the current user, or changes its duration. ) g.command 'setSnooze' do |c| - c.flag 'num_minutes', desc: 'Number of minutes, from now, to snooze until.' + c.flag 'num_minutes', desc: 'This argument is required. Number of minutes, from now, to snooze until.' c.action do |_global_options, options, _args| puts JSON.dump(@client.dnd_setSnooze(options)) end diff --git a/lib/slack/web/api/endpoints/admin_apps_activities.rb b/lib/slack/web/api/endpoints/admin_apps_activities.rb index fb9909b4..99f9870e 100644 --- a/lib/slack/web/api/endpoints/admin_apps_activities.rb +++ b/lib/slack/web/api/endpoints/admin_apps_activities.rb @@ -10,9 +10,9 @@ module AdminAppsActivities # Get logs for a specified team/org # # @option options [Object] :app_id - # The id of the app to get activities from. + # The ID of the app to get activities from. # @option options [string] :component_id - # The component id of log events to be returned. Will be 'FnXXXXXX' for functions, and 'WfXXXXXX' for worflows. + # The component ID of log events to be returned. Will be 'FnXXXXXX' for functions, and 'WfXXXXXX' for worflows. # @option options [string] :component_type # The component type of log events to be returned. Acceptable values are ('events_api', 'workflows', 'functions', 'tables'). # @option options [string] :cursor @@ -34,7 +34,7 @@ module AdminAppsActivities # @option options [string] :team_id # The team who owns this log. # @option options [string] :trace_id - # The trace id of log events to be returned. + # The trace ID of log events to be returned. # @see https://api.slack.com/methods/admin.apps.activities.list # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.activities/admin.apps.activities.list.json def admin_apps_activities_list(options = {}) diff --git a/lib/slack/web/api/endpoints/admin_users.rb b/lib/slack/web/api/endpoints/admin_users.rb index b5f2eaad..7ff147b6 100644 --- a/lib/slack/web/api/endpoints/admin_users.rb +++ b/lib/slack/web/api/endpoints/admin_users.rb @@ -114,7 +114,7 @@ def admin_users_setAdmin(options = {}) # Set an expiration for a guest user # # @option options [integer] :expiration_ts - # Timestamp when guest account should be disabled. + # Epoch timestamp in seconds when guest account should be disabled. # @option options [string] :user_id # The ID of the user to set an expiration for. # @option options [Object] :team_id diff --git a/lib/slack/web/api/endpoints/dnd.rb b/lib/slack/web/api/endpoints/dnd.rb index 13ed42b8..0b1229d7 100644 --- a/lib/slack/web/api/endpoints/dnd.rb +++ b/lib/slack/web/api/endpoints/dnd.rb @@ -42,7 +42,7 @@ def dnd_info(options = {}) # Turns on Do Not Disturb mode for the current user, or changes its duration. # # @option options [string] :num_minutes - # Number of minutes, from now, to snooze until. + # This argument is required. Number of minutes, from now, to snooze until. # @see https://api.slack.com/methods/dnd.setSnooze # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.setSnooze.json def dnd_setSnooze(options = {}) diff --git a/lib/slack/web/api/slack-api-ref b/lib/slack/web/api/slack-api-ref index f2e768a8..3686a784 160000 --- a/lib/slack/web/api/slack-api-ref +++ b/lib/slack/web/api/slack-api-ref @@ -1 +1 @@ -Subproject commit f2e768a8c3e1d5106a600ce2414b48e986b7d39a +Subproject commit 3686a784e3075cdc7dac4f8655c78040fba2b2d9