keybase-bot
Version:
Script Keybase in Node.js!
57 lines (56 loc) • 2.25 kB
TypeScript
import ClientBase from '../client-base';
import * as keybase1 from '../types/keybase1';
export interface CreateTeamParam {
team: string;
}
export interface AddMembersParam {
team: string;
emails?: keybase1.MemberEmail[];
usernames?: keybase1.MemberUsername[];
}
export interface RemoveMemberParam {
team: string;
username: string;
}
export interface ListTeamMembershipsParam {
team: string;
}
/** The team module of your Keybase bot. For more info about the API this module uses, you may want to check out `keybase team api`. */
declare class Team extends ClientBase {
/**
* Create a new Keybase team or subteam
* @memberof Team
* @param creation - the name of the team to create
* @returns -
* @example
* bot.team.create({"team": "phoenix"}).then(res => console.log(res))
*/
create(creation: CreateTeamParam): Promise<keybase1.TeamCreateResult>;
/**
* Add a bunch of people with different privileges to a team
* @memberof Team
* @param additions - an array of the users to add, with privs
* @returns - A result object of adding these members to the team.
* @example
* bot.team.addMembers({"team": "phoenix", "emails": [{"email": "alice@keybase.io", "role": "writer"}, {"email": "cleo@keybase.io", "role": "admin"}], "usernames": [{"username": "frank", "role": "reader"}, {"username": "keybaseio@twitter", "role": "writer"}]}).then(res => console.log(res))
*/
addMembers(additions: AddMembersParam): Promise<keybase1.TeamAddMemberResult>;
/**
* Remove someone from a team.
* @memberof Team
* @param removal - object with the `team` name and `username`
* @example
* bot.team.removeMember({"team": "phoenix", "username": "frank"}).then(res => console.log(res))
*/
removeMember(removal: RemoveMemberParam): Promise<void>;
/**
* List a team's members.
* @memberof Team
* @param team - an object with the `team` name in it.
* @returns - Details about the team.
* @example
* bot.team.listTeamMemberships({"team": "phoenix"}).then(res => console.log(res))
*/
listTeamMemberships(team: ListTeamMembershipsParam): Promise<keybase1.TeamDetails>;
}
export default Team;