Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/admin-slackbot-skills-setautoenabled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@slack/web-api": minor
---

feat(web-api): add [`admin.slackbot.skills.setAutoEnabled`](https://docs.slack.dev/reference/methods/admin.slackbot.skills.setAutoEnabled) method
10 changes: 10 additions & 0 deletions packages/web-api/src/methods.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ import type {
AdminRolesRemoveAssignmentsArguments,
AdminSlackbotSkillsListArguments,
AdminSlackbotSkillsPublishArguments,
AdminSlackbotSkillsSetAutoEnabledArguments,
AdminTeamsAdminsListArguments,
AdminTeamsCreateArguments,
AdminTeamsListArguments,
Expand Down Expand Up @@ -357,6 +358,7 @@ import type {
AdminRolesRemoveAssignmentsResponse,
AdminSlackbotSkillsListResponse,
AdminSlackbotSkillsPublishResponse,
AdminSlackbotSkillsSetAutoEnabledResponse,
AdminTeamsAdminsListResponse,
AdminTeamsCreateResponse,
AdminTeamsListResponse,
Expand Down Expand Up @@ -1152,6 +1154,14 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
this,
'admin.slackbot.skills.publish',
),
/**
* @description Sets who a Slackbot skill is automatically turned on for.
* @see {@link https://docs.slack.dev/reference/methods/admin.slackbot.skills.setAutoEnabled `admin.slackbot.skills.setAutoEnabled` API reference}.
*/
setAutoEnabled: bindApiCall<
AdminSlackbotSkillsSetAutoEnabledArguments,
AdminSlackbotSkillsSetAutoEnabledResponse
>(this, 'admin.slackbot.skills.setAutoEnabled'),
},
},
teams: {
Expand Down
13 changes: 13 additions & 0 deletions packages/web-api/src/types/request/admin/slackbot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,16 @@ export interface AdminSlackbotSkillsPublishArguments extends TokenOverridable {
/** @description One to 50 skill IDs. Successful items are not rolled back if other items fail. */
skill_ids: string[];
}

// https://docs.slack.dev/reference/methods/admin.slackbot.skills.setAutoEnabled
export interface AdminSlackbotSkillsSetAutoEnabledArguments extends TokenOverridable {
/** @description Canvas skill to deploy. */
skill_id: string;
/** @description Deployment audience. */
permission_type: 'everyone' | 'named_entities' | 'no_one';
/**
* @description One to 100 user groups for named_entities. Duplicates count toward the input limit and are stored
* once. Omit for other permission types.
*/
usergroup_ids?: string[];
}
1 change: 1 addition & 0 deletions packages/web-api/src/types/request/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ export type {
export type {
AdminSlackbotSkillsListArguments,
AdminSlackbotSkillsPublishArguments,
AdminSlackbotSkillsSetAutoEnabledArguments,
} from './admin/slackbot';
export type {
AdminTeamsAdminsListArguments,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
// //
// This file is auto-generated by scripts/generate-web-api-types.sh in the repository. //
// Please refer to the script code to learn how to update the source data. //
// //
/////////////////////////////////////////////////////////////////////////////////////////

import type { WebAPICallResult } from '../../WebClient';
export type AdminSlackbotSkillsSetAutoEnabledResponse = WebAPICallResult & {
error?: string;
invalid_usergroup_ids?: string[];
needed?: string;
ok?: boolean;
permission_type?: string;
provided?: string;
response_metadata?: ResponseMetadata;
skill_id?: string;
usergroup_ids?: string[];
warning?: string;
};

export interface ResponseMetadata {
messages?: string[];
}
1 change: 1 addition & 0 deletions packages/web-api/src/types/response/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export { AdminRolesListAssignmentsResponse } from './AdminRolesListAssignmentsRe
export { AdminRolesRemoveAssignmentsResponse } from './AdminRolesRemoveAssignmentsResponse';
export { AdminSlackbotSkillsListResponse } from './AdminSlackbotSkillsListResponse';
export { AdminSlackbotSkillsPublishResponse } from './AdminSlackbotSkillsPublishResponse';
export { AdminSlackbotSkillsSetAutoEnabledResponse } from './AdminSlackbotSkillsSetAutoEnabledResponse';
export { AdminTeamsAdminsListResponse } from './AdminTeamsAdminsListResponse';
export { AdminTeamsCreateResponse } from './AdminTeamsCreateResponse';
export { AdminTeamsListResponse } from './AdminTeamsListResponse';
Expand Down
41 changes: 41 additions & 0 deletions packages/web-api/test/types/methods/admin.slackbot.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,44 @@ expectAssignable<Parameters<typeof web.admin.slackbot.skills.publish>>([
skill_ids: ['F1234', 'F5678'],
},
]);

// admin.slackbot.skills.setAutoEnabled
// -- sad path
expectError(web.admin.slackbot.skills.setAutoEnabled()); // lacking argument
expectError(web.admin.slackbot.skills.setAutoEnabled({})); // empty argument
expectError(
web.admin.slackbot.skills.setAutoEnabled({
permission_type: 'everyone', // missing skill_id
}),
);
expectError(
web.admin.slackbot.skills.setAutoEnabled({
skill_id: 'F1234', // missing permission_type
}),
);
expectError(
web.admin.slackbot.skills.setAutoEnabled({
skill_id: 'F1234',
permission_type: 'some_people', // invalid permission_type
}),
);
// -- happy path
expectAssignable<Parameters<typeof web.admin.slackbot.skills.setAutoEnabled>>([
{
skill_id: 'F1234',
permission_type: 'everyone',
},
]);
expectAssignable<Parameters<typeof web.admin.slackbot.skills.setAutoEnabled>>([
{
skill_id: 'F1234',
permission_type: 'named_entities',
usergroup_ids: ['S1234'],
},
]);
expectAssignable<Parameters<typeof web.admin.slackbot.skills.setAutoEnabled>>([
{
skill_id: 'F1234',
permission_type: 'no_one',
},
]);
Loading