Skip to content

Commit 5de008a

Browse files
committed
Update API from slack-api-ref@c408935 (2025-09-21)
1 parent cec95a5 commit 5de008a

File tree

183 files changed

+1904
-1232
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+1904
-1232
lines changed

bin/commands/admin_analytics.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ class App
99
g.desc 'Retrieve analytics data for a given date, presented as a compressed JSON file'
1010
g.long_desc %( Retrieve analytics data for a given date, presented as a compressed JSON file )
1111
g.command 'getFile' do |c|
12-
c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).'
1312
c.flag 'date', desc: 'Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. Required unless metadata_only is set to true.'
13+
c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member (for Enterprise org member analytics) and public_channel (for public channel analytics).'
1414
c.flag 'metadata_only', desc: 'Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.'
1515
c.action do |_global_options, options, _args|
1616
puts JSON.dump(@client.admin_analytics_getFile(options))

bin/commands/admin_apps.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ class App
1010
g.long_desc %( Approve an app for installation on a workspace. )
1111
g.command 'approve' do |c|
1212
c.flag 'app_id', desc: 'The id of the app to approve.'
13-
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
1413
c.flag 'request_id', desc: 'The id of the request to approve.'
1514
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
15+
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
1616
c.action do |_global_options, options, _args|
1717
puts JSON.dump(@client.admin_apps_approve(options))
1818
end
@@ -22,8 +22,8 @@ class App
2222
g.long_desc %( Clear an app resolution )
2323
g.command 'clearResolution' do |c|
2424
c.flag 'app_id', desc: 'The id of the app whose resolution you want to clear/undo.'
25-
c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
2625
c.flag 'team_id', desc: 'The workspace to clear the app resolution from.'
26+
c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
2727
c.action do |_global_options, options, _args|
2828
puts JSON.dump(@client.admin_apps_clearResolution(options))
2929
end
@@ -33,9 +33,9 @@ class App
3333
g.long_desc %( Restrict an app for installation on a workspace. )
3434
g.command 'restrict' do |c|
3535
c.flag 'app_id', desc: 'The id of the app to restrict.'
36-
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
3736
c.flag 'request_id', desc: 'The id of the request to restrict.'
3837
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
38+
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
3939
c.action do |_global_options, options, _args|
4040
puts JSON.dump(@client.admin_apps_restrict(options))
4141
end
@@ -45,8 +45,8 @@ class App
4545
g.long_desc %( Uninstall an app from one or many workspaces, or an entire enterprise organization. )
4646
g.command 'uninstall' do |c|
4747
c.flag 'app_id', desc: 'The ID of the app to uninstall.'
48-
c.flag 'enterprise_id', desc: 'The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.'
4948
c.flag 'team_ids', desc: 'IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.'
49+
c.flag 'enterprise_id', desc: 'The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.'
5050
c.action do |_global_options, options, _args|
5151
puts JSON.dump(@client.admin_apps_uninstall(options))
5252
end

bin/commands/admin_apps_activities.rb

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ class App
1010
g.long_desc %( Get logs for a specified team/org )
1111
g.command 'list' do |c|
1212
c.flag 'app_id', desc: 'The ID of the app to get activities from.'
13-
c.flag 'component_id', desc: 'The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for worflows.'
14-
c.flag 'component_type', desc: 'The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.'
13+
c.flag 'team_id', desc: 'The team who owns this log.'
1514
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."
1615
c.flag 'limit', desc: 'The maximum number of items to return.'
17-
c.flag 'log_event_type', desc: 'The event type of log events to be returned.'
18-
c.flag 'max_date_created', desc: 'The latest timestamp of the log to retrieve (epoch microseconds).'
19-
c.flag 'min_date_created', desc: 'The earliest timestamp of the log to retrieve (epoch microseconds).'
2016
c.flag 'min_log_level', desc: 'The minimum log level of the log events to be returned. Defaults to info. Acceptable values (in order of relative importance from smallest to largest) are trace, debug, info, warn, error and fatal.'
21-
c.flag 'sort_direction', desc: 'The direction you want the data sorted by (always by timestamp).'
17+
c.flag 'log_event_type', desc: 'The event type of log events to be returned.'
2218
c.flag 'source', desc: 'The source of log events to be returned. Acceptable values are slack and developer.'
23-
c.flag 'team_id', desc: 'The team who owns this log.'
19+
c.flag 'component_type', desc: 'The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.'
20+
c.flag 'component_id', desc: 'The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for workflows.'
2421
c.flag 'trace_id', desc: 'The trace ID of log events to be returned.'
22+
c.flag 'min_date_created', desc: 'The earliest timestamp of the log to retrieve (epoch microseconds).'
23+
c.flag 'max_date_created', desc: 'The latest timestamp of the log to retrieve (epoch microseconds).'
24+
c.flag 'sort_direction', desc: 'The direction you want the data sorted by (always by timestamp).'
2525
c.action do |_global_options, options, _args|
2626
puts JSON.dump(@client.admin_apps_activities_list(options))
2727
end

bin/commands/admin_apps_approved.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ class App
99
g.desc 'List approved apps for an org or workspace.'
1010
g.long_desc %( List approved apps for an org or workspace. )
1111
g.command 'list' do |c|
12-
c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
13-
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
14-
c.flag 'enterprise_id', desc: '.'
1512
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
16-
c.flag 'team_id', desc: '.'
13+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
14+
c.flag 'team_id', desc: ''
15+
c.flag 'enterprise_id', desc: ''
16+
c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
1717
c.action do |_global_options, options, _args|
1818
puts JSON.dump(@client.admin_apps_approved_list(options))
1919
end

bin/commands/admin_apps_config.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ class App
1010
g.long_desc %( Look up the app config for connectors by their IDs )
1111
g.command 'lookup' do |c|
1212
c.flag 'app_ids', desc: 'An array of app IDs to get app configs for.'
13+
c.flag 'rich_link_preview_types', desc: 'return apps with the corresponding rich link preview layouts.'
1314
c.action do |_global_options, options, _args|
1415
puts JSON.dump(@client.admin_apps_config_lookup(options))
1516
end
@@ -19,8 +20,9 @@ class App
1920
g.long_desc %( Set the app config for a connector )
2021
g.command 'set' do |c|
2122
c.flag 'app_id', desc: 'The encoded app ID to set the app config for.'
22-
c.flag 'domain_restrictions', desc: 'Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.'
2323
c.flag 'workflow_auth_strategy', desc: 'The workflow auth permission. Can be one of builder_choice or end_user_only.'
24+
c.flag 'rich_link_preview_type', desc: 'Indicates the app-level override for rich link preview. Unsupported for free teams.'
25+
c.flag 'domain_restrictions', desc: 'Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.'
2426
c.action do |_global_options, options, _args|
2527
puts JSON.dump(@client.admin_apps_config_set(options))
2628
end

bin/commands/admin_apps_requests.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ class App
1010
g.long_desc %( Cancel app request for team )
1111
g.command 'cancel' do |c|
1212
c.flag 'request_id', desc: 'The id of the request to cancel.'
13-
c.flag 'enterprise_id', desc: 'The ID of the enterprise where this request belongs.'
1413
c.flag 'team_id', desc: 'The ID of the workspace where this request belongs.'
14+
c.flag 'enterprise_id', desc: 'The ID of the enterprise where this request belongs.'
1515
c.action do |_global_options, options, _args|
1616
puts JSON.dump(@client.admin_apps_requests_cancel(options))
1717
end
@@ -20,11 +20,11 @@ class App
2020
g.desc 'List app requests for a team/workspace.'
2121
g.long_desc %( List app requests for a team/workspace. )
2222
g.command 'list' do |c|
23-
c.flag 'certified', desc: 'Include requests for certified apps.'
24-
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
25-
c.flag 'enterprise_id', desc: '.'
2623
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
27-
c.flag 'team_id', desc: '.'
24+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
25+
c.flag 'team_id', desc: ''
26+
c.flag 'enterprise_id', desc: ''
27+
c.flag 'certified', desc: 'Include requests for certified apps.'
2828
c.action do |_global_options, options, _args|
2929
puts JSON.dump(@client.admin_apps_requests_list(options))
3030
end

bin/commands/admin_apps_restricted.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ class App
99
g.desc 'List restricted apps for an org or workspace.'
1010
g.long_desc %( List restricted apps for an org or workspace. )
1111
g.command 'list' do |c|
12-
c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
13-
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
14-
c.flag 'enterprise_id', desc: '.'
1512
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
16-
c.flag 'team_id', desc: '.'
13+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
14+
c.flag 'team_id', desc: ''
15+
c.flag 'enterprise_id', desc: ''
16+
c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
1717
c.action do |_global_options, options, _args|
1818
puts JSON.dump(@client.admin_apps_restricted_list(options))
1919
end

bin/commands/admin_audit_anomaly_allow.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ module Cli
66
class App
77
desc 'AdminAuditAnomalyAllow methods.'
88
command 'admin_audit_anomaly_allow' do |g|
9-
g.desc 'API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration.'
10-
g.long_desc %( API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration. )
9+
g.desc 'API to allow Enterprise org admins to read the allow list of IP blocks and ASNs from the enterprise configuration.'
10+
g.long_desc %( API to allow Enterprise org admins to read the allow list of IP blocks and ASNs from the enterprise configuration. )
1111
g.command 'getItem' do |c|
1212
c.action do |_global_options, options, _args|
1313
puts JSON.dump(@client.admin_audit_anomaly_allow_getItem(options))
1414
end
1515
end
1616

17-
g.desc 'API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.'
18-
g.long_desc %( API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration. )
17+
g.desc 'API to allow Enterprise org admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.'
18+
g.long_desc %( API to allow Enterprise org admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration. )
1919
g.command 'updateItem' do |c|
20-
c.flag 'trusted_asns', desc: 'allow list of Autonomous System Numbers (ASN) in the enterprise grid configuarion.'
21-
c.flag 'trusted_cidr', desc: 'allow list of IPv4 addressses using cidr notation in the enterprise grid configuarion.'
20+
c.flag 'trusted_cidr', desc: 'allow list of IPv4 addresses using cidr notation in the Enterprise organization configuration.'
21+
c.flag 'trusted_asns', desc: 'allow list of Autonomous System Numbers (ASN) in the Enterprise organization configuration.'
2222
c.action do |_global_options, options, _args|
2323
puts JSON.dump(@client.admin_audit_anomaly_allow_updateItem(options))
2424
end

bin/commands/admin_auth_policy.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ class App
99
g.desc 'Assign entities to a particular authentication policy.'
1010
g.long_desc %( Assign entities to a particular authentication policy. )
1111
g.command 'assignEntities' do |c|
12-
c.flag 'entity_ids', desc: 'Array of IDs to assign to the policy.'
13-
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
1412
c.flag 'policy_name', desc: 'The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.'
13+
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
14+
c.flag 'entity_ids', desc: 'Array of IDs to assign to the policy.'
1515
c.action do |_global_options, options, _args|
1616
puts JSON.dump(@client.admin_auth_policy_assignEntities(options))
1717
end
@@ -21,9 +21,9 @@ class App
2121
g.long_desc %( Fetch all the entities assigned to a particular authentication policy by name. )
2222
g.command 'getEntities' do |c|
2323
c.flag 'policy_name', desc: 'The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.'
24-
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
2524
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
2625
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 and 1000, both inclusive.'
26+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
2727
c.action do |_global_options, options, _args|
2828
puts JSON.dump(@client.admin_auth_policy_getEntities(options))
2929
end
@@ -32,9 +32,9 @@ class App
3232
g.desc 'Remove specified entities from a specified authentication policy.'
3333
g.long_desc %( Remove specified entities from a specified authentication policy. )
3434
g.command 'removeEntities' do |c|
35-
c.flag 'entity_ids', desc: "Encoded IDs of the entities you'd like to remove from the policy."
36-
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
3735
c.flag 'policy_name', desc: 'The name of the policy to remove entities from. Currently, email_password is the only policy that may be used with this method.'
36+
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
37+
c.flag 'entity_ids', desc: "Encoded IDs of the entities you'd like to remove from the policy."
3838
c.action do |_global_options, options, _args|
3939
puts JSON.dump(@client.admin_auth_policy_removeEntities(options))
4040
end

bin/commands/admin_barriers.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ class App
99
g.desc 'Create an Information Barrier'
1010
g.long_desc %( Create an Information Barrier )
1111
g.command 'create' do |c|
12-
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
1312
c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
13+
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
1414
c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
1515
c.action do |_global_options, options, _args|
1616
puts JSON.dump(@client.admin_barriers_create(options))
@@ -29,8 +29,8 @@ class App
2929
g.desc 'Get all Information Barriers for your organization'
3030
g.long_desc %( Get all Information Barriers for your organization )
3131
g.command 'list' do |c|
32-
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
3332
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
33+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
3434
c.action do |_global_options, options, _args|
3535
puts JSON.dump(@client.admin_barriers_list(options))
3636
end
@@ -40,8 +40,8 @@ class App
4040
g.long_desc %( Update an existing Information Barrier )
4141
g.command 'update' do |c|
4242
c.flag 'barrier_id', desc: "The ID of the barrier you're trying to modify."
43-
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
4443
c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
44+
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
4545
c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
4646
c.action do |_global_options, options, _args|
4747
puts JSON.dump(@client.admin_barriers_update(options))

0 commit comments

Comments
 (0)