2021-02-20 09:55:57 -08:00
import {
INodeProperties ,
} from 'n8n-workflow' ;
2021-12-03 00:44:16 -08:00
export const groupOperations : INodeProperties [ ] = [
2021-02-20 09:55:57 -08:00
{
displayName : 'Operation' ,
name : 'operation' ,
type : 'options' ,
default : 'get' ,
description : 'Operation to perform' ,
options : [
{
name : 'Create' ,
value : 'create' ,
} ,
{
name : 'Delete' ,
value : 'delete' ,
} ,
{
name : 'Get' ,
value : 'get' ,
} ,
{
name : 'Get All' ,
value : 'getAll' ,
} ,
{
name : 'Get Members' ,
value : 'getMembers' ,
} ,
{
name : 'Update' ,
value : 'update' ,
} ,
{
name : 'Update Members' ,
value : 'updateMembers' ,
} ,
] ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
} ,
} ,
} ,
2021-12-03 00:44:16 -08:00
] ;
2021-02-20 09:55:57 -08:00
2021-12-03 00:44:16 -08:00
export const groupFields : INodeProperties [ ] = [
2021-02-20 09:55:57 -08:00
// ----------------------------------
// group: shared
// ----------------------------------
{
displayName : 'Group ID' ,
name : 'groupId' ,
type : 'string' ,
required : true ,
description : 'The identifier of the group.' ,
default : '' ,
placeholder : '5e59c8c7-e05a-4d17-8e85-acc301343926' ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'delete' ,
'get' ,
'getMembers' ,
'update' ,
'updateMembers' ,
] ,
} ,
} ,
} ,
// ----------------------------------
// group: getAll
// ----------------------------------
{
displayName : 'Return All' ,
name : 'returnAll' ,
type : 'boolean' ,
default : false ,
description : 'Return all available results for the query.' ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'getAll' ,
] ,
} ,
} ,
} ,
{
displayName : 'Limit' ,
name : 'limit' ,
type : 'number' ,
default : 10 ,
description : 'Number of results to return for the query.' ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'getAll' ,
] ,
returnAll : [
false ,
] ,
} ,
} ,
} ,
// ----------------------------------
// group: create
// ----------------------------------
{
displayName : 'Name' ,
name : 'name' ,
type : 'string' ,
default : '' ,
required : true ,
description : 'The name of the group to create.' ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'create' ,
] ,
} ,
} ,
} ,
{
displayName : 'Access All' ,
name : 'accessAll' ,
type : 'boolean' ,
default : false ,
2021-11-25 09:10:06 -08:00
description : 'Allow this group to access all collections within the organization, instead of only its associated collections. If set to true, this option overrides any collection assignments.' ,
2021-02-20 09:55:57 -08:00
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'create' ,
] ,
} ,
} ,
} ,
{
displayName : 'Additional Fields' ,
name : 'additionalFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
options : [
{
displayName : 'Collections' ,
name : 'collections' ,
type : 'multiOptions' ,
description : 'The collections to assign to this group.' ,
default : [ ] ,
typeOptions : {
loadOptionsMethod : 'getCollections' ,
} ,
} ,
{
displayName : 'External ID' ,
name : 'externalId' ,
type : 'string' ,
description : 'The external identifier to set to this group.' ,
default : '' ,
} ,
] ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'create' ,
] ,
} ,
} ,
} ,
// ----------------------------------
// group: update
// ----------------------------------
{
displayName : 'Update Fields' ,
name : 'updateFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
options : [
{
displayName : 'Access All' ,
name : 'accessAll' ,
type : 'boolean' ,
default : false ,
2021-11-25 09:10:06 -08:00
description : 'Allow this group to access all collections within the organization, instead of only its associated collections. If set to true, this option overrides any collection assignments.' ,
2021-02-20 09:55:57 -08:00
} ,
{
displayName : 'Collections' ,
name : 'collections' ,
type : 'multiOptions' ,
description : 'The collections to assign to this group.' ,
default : [ ] ,
typeOptions : {
loadOptionsMethod : 'getCollections' ,
} ,
} ,
{
displayName : 'External ID' ,
name : 'externalId' ,
type : 'string' ,
description : 'The external identifier to set to this group.' ,
default : '' ,
} ,
{
displayName : 'Name' ,
name : 'name' ,
type : 'string' ,
default : '' ,
description : 'The name of the group to update.' ,
} ,
] ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'update' ,
] ,
} ,
} ,
} ,
// ----------------------------------
// group: updateMembers
// ----------------------------------
{
displayName : 'Member IDs' ,
name : 'memberIds' ,
type : 'string' ,
default : '' ,
description : 'Comma-separated list of IDs of members to set in a group.' ,
displayOptions : {
show : {
resource : [
'group' ,
] ,
operation : [
'updateMembers' ,
] ,
} ,
} ,
} ,
2021-12-03 00:44:16 -08:00
] ;
2021-02-20 09:55:57 -08:00
type GroupSchema = {
name : string ;
collections : string [ ] ;
accessAll : boolean ;
externalId : string ;
} ;
export type GroupUpdateFields = GroupSchema ;
export type GroupCreationAdditionalFields = Omit < GroupSchema , ' name ' > ;