Skip to content
Merged
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/slackbot-skills-info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@slack/web-api": minor
---

feat(web-api): add [`slackbot.skills.info`](https://docs.slack.dev/reference/methods/slackbot.skills.info) method
7 changes: 7 additions & 0 deletions packages/web-api/src/methods.ts
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ import type {
SearchFilesArguments,
SearchMessagesArguments,
SlackbotSkillsCreateArguments,
SlackbotSkillsInfoArguments,
SlackListsAccessDeleteArguments,
SlackListsAccessSetArguments,
SlackListsCreateArguments,
Expand Down Expand Up @@ -520,6 +521,7 @@ import type {
SearchFilesResponse,
SearchMessagesResponse,
SlackbotSkillsCreateResponse,
SlackbotSkillsInfoResponse,
SlackListsAccessDeleteResponse,
SlackListsAccessSetResponse,
SlackListsCreateResponse,
Expand Down Expand Up @@ -2359,6 +2361,11 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
* @see {@link https://docs.slack.dev/reference/methods/slackbot.skills.create `slackbot.skills.create` API reference}.
*/
create: bindApiCall<SlackbotSkillsCreateArguments, SlackbotSkillsCreateResponse>(this, 'slackbot.skills.create'),
/**
* @description Returns one Slackbot skill, including its instructions.
* @see {@link https://docs.slack.dev/reference/methods/slackbot.skills.info `slackbot.skills.info` API reference}.
*/
info: bindApiCall<SlackbotSkillsInfoArguments, SlackbotSkillsInfoResponse>(this, 'slackbot.skills.info'),
},
};

Expand Down
5 changes: 4 additions & 1 deletion packages/web-api/src/types/request/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,10 @@ export type {
SearchFilesArguments,
SearchMessagesArguments,
} from './search';
export type { SlackbotSkillsCreateArguments } from './slackbot';
export type {
SlackbotSkillsCreateArguments,
SlackbotSkillsInfoArguments,
} from './slackbot';
export type {
SlackListsAccessDeleteArguments,
SlackListsAccessSetArguments,
Expand Down
5 changes: 5 additions & 0 deletions packages/web-api/src/types/request/slackbot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,8 @@ export interface SlackbotSkillsCreateArguments extends TokenOverridable {
server_id?: string;
}[];
}
// https://docs.slack.dev/reference/methods/slackbot.skills.info
export interface SlackbotSkillsInfoArguments extends TokenOverridable {
/** @description Skill to fetch: a canvas file ID or a `builtin:` reference. */
skill_id: string;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! 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 SlackbotSkillsInfoResponse = WebAPICallResult & {
error?: string;
needed?: string;
ok?: boolean;
provided?: string;
response_metadata?: ResponseMetadata;
skill?: Skill;
warning?: string;
};

export interface ResponseMetadata {
messages?: string[];
}

export interface Skill {
access?: string;
category?: string;
creator_id?: string;
date_created?: number;
date_updated?: number;
description?: string;
display_name?: string;
example_prompt?: string;
id?: string;
instructions?: string;
is_official?: boolean;
library_count?: number;
mcp_servers?: McpServer[];
name?: string;
permalink?: string;
type?: string;
usage_count?: number;
visibility?: string;
}

export interface McpServer {
app_id?: string;
display_name?: string;
is_available?: boolean;
server_id?: string;
service_type?: 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 @@ -293,6 +293,7 @@ export { SearchAllResponse } from './SearchAllResponse';
export { SearchFilesResponse } from './SearchFilesResponse';
export { SearchMessagesResponse } from './SearchMessagesResponse';
export { SlackbotSkillsCreateResponse } from './SlackbotSkillsCreateResponse';
export { SlackbotSkillsInfoResponse } from './SlackbotSkillsInfoResponse';
export { SlackListsAccessDeleteResponse } from './SlackListsAccessDeleteResponse';
export { SlackListsAccessSetResponse } from './SlackListsAccessSetResponse';
export { SlackListsCreateResponse } from './SlackListsCreateResponse';
Expand Down
11 changes: 11 additions & 0 deletions packages/web-api/test/types/methods/slackbot.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,14 @@ expectAssignable<Parameters<typeof web.slackbot.skills.create>>([
mcp_servers: [{ service_type: 'app', app_id: 'A1234', server_id: 'Amcp1234' }],
},
]);

// slackbot.skills.info
// -- sad path
expectError(web.slackbot.skills.info()); // lacking argument
expectError(web.slackbot.skills.info({})); // empty argument
// -- happy path
expectAssignable<Parameters<typeof web.slackbot.skills.info>>([
{
skill_id: 'F1234',
},
]);
Loading