n8n/packages/nodes-base/nodes/Slack/ChannelDescription.ts

905 lines
18 KiB
TypeScript
Raw Normal View History

2020-03-05 15:25:18 -08:00
import { INodeProperties } from 'n8n-workflow';
export const channelOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'channel',
],
},
},
options: [
2020-03-08 15:22:33 -07:00
{
name: 'Archive',
value: 'archive',
description: 'Archives a conversation.',
},
{
name: 'Close',
value: 'close',
description: 'Closes a direct message or multi-person direct message.',
},
2020-03-05 15:25:18 -08:00
{
name: 'Create',
value: 'create',
description: 'Initiates a public or private channel-based conversation',
},
2020-03-08 15:22:33 -07:00
{
name: 'Get',
value: 'get',
description: 'Get information about a channel.',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all channels in a Slack team.',
},
{
name: 'History',
value: 'history',
description: `Get a conversation's history of messages and events.`,
},
2020-03-05 15:25:18 -08:00
{
name: 'Invite',
value: 'invite',
description: 'Invite a user to a channel',
},
2020-03-08 15:22:33 -07:00
{
name: 'Join',
value: 'join',
description: 'Joins an existing conversation.',
},
{
name: 'Kick',
value: 'kick',
description: 'Removes a user from a channel.',
},
{
name: 'Leave',
value: 'leave',
description: 'Leaves a conversation.',
},
{
name: 'Open',
value: 'open',
description: 'Opens or resumes a direct message or multi-person direct message.',
},
{
name: 'Rename',
value: 'rename',
description: 'Renames a conversation.',
},
{
name: 'Replies',
value: 'replies',
description: 'Get a thread of messages posted to a channel',
},
{
name: 'Set Purpose',
value: 'setPurpose',
description: 'Sets the purpose for a conversation.',
},
{
name: 'Set Topic',
value: 'setTopic',
description: 'Sets the topic for a conversation.',
},
{
name: 'Unarchive',
value: 'unarchive',
description: 'Unarchives a conversation.',
},
2020-03-05 15:25:18 -08:00
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const channelFields = [
2020-03-08 15:22:33 -07:00
/* -------------------------------------------------------------------------- */
/* channel:archive */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'archive',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'The name of the channel to archive.',
},
/* -------------------------------------------------------------------------- */
/* channel:close */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'close',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'The name of the channel to close.',
},
2020-03-05 15:25:18 -08:00
/* -------------------------------------------------------------------------- */
/* channel:create */
/* -------------------------------------------------------------------------- */
{
2020-03-08 15:22:33 -07:00
displayName: 'Channel',
name: 'channelId',
2020-03-05 15:25:18 -08:00
type: 'string',
default: '',
placeholder: 'Channel name',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'create',
2020-03-05 15:25:18 -08:00
],
resource: [
'channel',
],
},
},
required: true,
description: 'The name of the channel to create.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Is Private',
name: 'isPrivate',
type: 'boolean',
default: false,
2020-03-08 15:22:33 -07:00
description: 'Create a private channel instead of a public one',
2020-03-05 15:25:18 -08:00
},
2020-10-22 06:46:03 -07:00
],
2020-03-05 15:25:18 -08:00
},
/* -------------------------------------------------------------------------- */
/* channel:invite */
/* -------------------------------------------------------------------------- */
{
2020-03-08 15:22:33 -07:00
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
2020-03-05 15:25:18 -08:00
default: '',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'invite',
2020-03-05 15:25:18 -08:00
],
resource: [
'channel',
],
},
},
required: true,
description: 'The ID of the channel to invite user to.',
},
{
displayName: 'User IDs',
name: 'userIds',
type: 'multiOptions',
2020-03-15 07:51:49 -07:00
typeOptions: {
loadOptionsMethod: 'getUsers',
},
2020-03-05 15:25:18 -08:00
default: '',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'invite',
2020-03-05 15:25:18 -08:00
],
resource: [
'channel',
],
},
},
required: true,
description: 'The ID of the user to invite into channel.',
},
/* -------------------------------------------------------------------------- */
/* channel:get */
/* -------------------------------------------------------------------------- */
2020-03-08 15:22:33 -07:00
{
displayName: 'Channel',
name: 'channelId',
type: 'string',
default: '',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'get',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
required: true,
description: 'Channel ID to learn more about',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'get',
],
},
},
options: [
{
displayName: 'Include Num of Members',
name: 'includeNumMembers',
type: 'boolean',
default: false,
},
2020-10-22 06:46:03 -07:00
],
2020-03-08 15:22:33 -07:00
},
2020-03-05 15:25:18 -08:00
/* -------------------------------------------------------------------------- */
2020-03-08 15:22:33 -07:00
/* channel:kick */
2020-03-05 15:25:18 -08:00
/* -------------------------------------------------------------------------- */
2020-03-08 15:22:33 -07:00
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
default: '',
placeholder: 'Channel name',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'kick',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
required: true,
description: 'The name of the channel to create.',
},
{
2020-03-15 07:51:49 -07:00
displayName: 'User',
2020-03-08 15:22:33 -07:00
name: 'userId',
2020-03-15 07:51:49 -07:00
type: 'options',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
2020-03-08 15:22:33 -07:00
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'kick',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
},
/* -------------------------------------------------------------------------- */
/* channel:join */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
default: '',
placeholder: 'Channel name',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'join',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
required: true,
},
2020-03-05 15:25:18 -08:00
/* -------------------------------------------------------------------------- */
/* channel:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'getAll',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
{
2020-03-08 15:22:33 -07:00
displayName: 'Filters',
name: 'filters',
2020-03-05 15:25:18 -08:00
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'getAll',
],
},
},
options: [
{
2020-03-08 15:22:33 -07:00
displayName: 'Exclude Archived',
name: 'excludeArchived',
type: 'boolean',
default: false,
description: 'Set to true to exclude archived channels from the list',
},
{
displayName: 'Types',
name: 'types',
type: 'multiOptions',
options: [
{
name: 'Public Channel',
2020-10-22 06:46:03 -07:00
value: 'public_channel',
2020-03-08 15:22:33 -07:00
},
{
name: 'Private Channel',
2020-10-22 06:46:03 -07:00
value: 'private_channel',
2020-03-08 15:22:33 -07:00
},
{
name: 'mpim',
2020-10-22 06:46:03 -07:00
value: 'mpim',
2020-03-08 15:22:33 -07:00
},
{
name: 'im',
2020-10-22 06:46:03 -07:00
value: 'im',
2020-03-08 15:22:33 -07:00
},
],
default: ['public_channel'],
description: 'Mix and match channel types',
},
2020-10-22 06:46:03 -07:00
],
2020-03-08 15:22:33 -07:00
},
/* -------------------------------------------------------------------------- */
/* channel:history */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
default: '',
placeholder: 'Channel name',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'history',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
required: true,
description: 'The name of the channel to create.',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'history',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'history',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'history',
],
},
},
options: [
{
displayName: 'Inclusive',
name: 'inclusive',
type: 'boolean',
default: false,
description: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.',
},
{
displayName: 'Latest',
name: 'latest',
type: 'dateTime',
2020-03-05 15:25:18 -08:00
default: '',
2020-03-08 15:22:33 -07:00
description: 'End of time range of messages to include in results.',
},
{
displayName: 'Oldest',
name: 'oldest',
type: 'dateTime',
default: '',
description: 'Start of time range of messages to include in results.',
2020-03-05 15:25:18 -08:00
},
2020-10-22 06:46:03 -07:00
],
2020-03-05 15:25:18 -08:00
},
2020-03-08 15:22:33 -07:00
/* -------------------------------------------------------------------------- */
/* channel:leave */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'leave',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'The name of the channel to leave.',
},
/* -------------------------------------------------------------------------- */
/* channel:open */
/* -------------------------------------------------------------------------- */
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'open',
],
},
},
options: [
{
displayName: 'Channel ID',
name: 'channelId',
type: 'string',
default: '',
description: `Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead`,
},
{
displayName: 'Return IM',
name: 'returnIm',
type: 'boolean',
default: false,
description: 'Boolean, indicates you want the full IM channel definition in the response.',
},
{
displayName: 'Users',
name: 'users',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
default: [],
description: `If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.`,
},
2020-10-22 06:46:03 -07:00
],
2020-03-08 15:22:33 -07:00
},
/* -------------------------------------------------------------------------- */
/* channel:rename */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'rename',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'The name of the channel to rename.',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'rename',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'New name for conversation.',
},
/* -------------------------------------------------------------------------- */
/* channel:replies */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
default: '',
placeholder: 'Channel name',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'replies',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
required: true,
description: 'The name of the channel to create.',
},
{
displayName: 'TS',
name: 'ts',
type: 'string',
default: '',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'replies',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
required: true,
description: `Unique identifier of a thread's parent message.`,
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'replies',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'replies',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'channel',
],
operation: [
'replies',
],
},
},
options: [
{
displayName: 'Inclusive',
name: 'inclusive',
type: 'boolean',
default: false,
description: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.',
},
{
displayName: 'Latest',
name: 'latest',
type: 'string',
default: '',
description: 'End of time range of messages to include in results.',
},
{
displayName: 'Oldest',
name: 'oldest',
type: 'string',
default: '',
description: 'Start of time range of messages to include in results.',
},
2020-10-22 06:46:03 -07:00
],
2020-03-08 15:22:33 -07:00
},
/* -------------------------------------------------------------------------- */
/* channel:setPurpose */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'setPurpose',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'Conversation to set the purpose of',
},
{
displayName: 'Purpose',
name: 'purpose',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'setPurpose',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'A new, specialer purpose',
},
/* -------------------------------------------------------------------------- */
/* channel:setTopic */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'setTopic',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'Conversation to set the topic of',
},
{
displayName: 'Topic',
name: 'topic',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'setTopic',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'The new topic string. Does not support formatting or linkification.',
},
/* -------------------------------------------------------------------------- */
/* channel:unarchive */
/* -------------------------------------------------------------------------- */
{
displayName: 'Channel',
name: 'channelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'unarchive',
2020-03-08 15:22:33 -07:00
],
resource: [
'channel',
],
},
},
default: '',
required: true,
description: 'The ID of the channel to unarchive.',
},
2020-03-05 15:25:18 -08:00
] as INodeProperties[];