2023-01-27 03:22:44 -08:00
import type { INodeProperties } from 'n8n-workflow' ;
2021-02-20 09:55:57 -08:00
2021-12-03 00:44:16 -08:00
export const memberOperations : INodeProperties [ ] = [
2021-02-20 09:55:57 -08:00
{
displayName : 'Operation' ,
name : 'operation' ,
type : 'options' ,
2022-05-20 14:47:24 -07:00
noDataExpression : true ,
2021-02-20 09:55:57 -08:00
default : 'get' ,
options : [
{
name : 'Create' ,
value : 'create' ,
2022-07-10 13:50:51 -07:00
action : 'Create a member' ,
2021-02-20 09:55:57 -08:00
} ,
{
name : 'Delete' ,
value : 'delete' ,
2022-07-10 13:50:51 -07:00
action : 'Delete a member' ,
2021-02-20 09:55:57 -08:00
} ,
{
name : 'Get' ,
value : 'get' ,
2022-07-10 13:50:51 -07:00
action : 'Get a member' ,
2021-02-20 09:55:57 -08:00
} ,
{
name : 'Get Groups' ,
value : 'getGroups' ,
2022-07-10 13:50:51 -07:00
action : 'Get groups for a member' ,
2021-02-20 09:55:57 -08:00
} ,
{
2022-09-07 07:51:14 -07:00
name : 'Get Many' ,
value : 'getAll' ,
2022-09-08 08:10:13 -07:00
action : 'Get many members' ,
2022-09-07 07:51:14 -07:00
} ,
{
2021-02-20 09:55:57 -08:00
name : 'Update' ,
value : 'update' ,
2022-07-10 13:50:51 -07:00
action : 'Update a member' ,
2021-02-20 09:55:57 -08:00
} ,
{
name : 'Update Groups' ,
value : 'updateGroups' ,
2022-07-10 13:50:51 -07:00
action : 'Update groups for a member' ,
2021-02-20 09:55:57 -08:00
} ,
] ,
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
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 memberFields : INodeProperties [ ] = [
2021-02-20 09:55:57 -08:00
// ----------------------------------
// member: shared
// ----------------------------------
{
displayName : 'Member ID' ,
name : 'memberId' ,
type : 'string' ,
required : true ,
2022-05-06 14:01:25 -07:00
description : 'The identifier of the member' ,
2021-02-20 09:55:57 -08:00
default : '' ,
placeholder : '5e59c8c7-e05a-4d17-8e85-acc301343926' ,
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'delete' , 'get' , 'getGroups' , 'update' , 'updateGroups' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
{
displayName : 'Type' ,
name : 'type' ,
type : 'options' ,
default : 2 ,
required : true ,
options : [
{
name : 'Owner' ,
value : 0 ,
} ,
{
name : 'Admin' ,
value : 1 ,
} ,
{
name : 'User' ,
value : 2 ,
} ,
{
name : 'Manager' ,
value : 3 ,
} ,
] ,
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'create' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
// ----------------------------------
// member: getAll
// ----------------------------------
{
displayName : 'Return All' ,
name : 'returnAll' ,
type : 'boolean' ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Whether to return all results or only up to a given limit' ,
2021-02-20 09:55:57 -08:00
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'getAll' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
{
displayName : 'Limit' ,
name : 'limit' ,
type : 'number' ,
2022-05-20 14:47:24 -07:00
typeOptions : {
minValue : 1 ,
} ,
2021-02-20 09:55:57 -08:00
default : 10 ,
2022-05-06 14:01:25 -07:00
description : 'Max number of results to return' ,
2021-02-20 09:55:57 -08:00
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'getAll' ] ,
returnAll : [ false ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
// ----------------------------------
// member: create
// ----------------------------------
{
displayName : 'Email' ,
name : 'email' ,
type : 'string' ,
2022-06-20 07:54:01 -07:00
placeholder : 'name@email.com' ,
2021-02-20 09:55:57 -08:00
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'The email of the member to update' ,
2021-02-20 09:55:57 -08:00
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'create' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
{
displayName : 'Access All' ,
name : 'accessAll' ,
type : 'boolean' ,
default : false ,
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'create' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
{
displayName : 'Additional Fields' ,
name : 'additionalFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
options : [
{
2022-06-20 07:54:01 -07:00
displayName : 'Collection Names or IDs' ,
2021-02-20 09:55:57 -08:00
name : 'collections' ,
type : 'multiOptions' ,
2022-08-01 13:47:55 -07:00
description :
'The collections to assign to this member. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.' ,
2021-02-20 09:55:57 -08:00
default : [ ] ,
typeOptions : {
loadOptionsMethod : 'getCollections' ,
} ,
} ,
{
displayName : 'External ID' ,
name : 'externalId' ,
type : 'string' ,
2022-05-06 14:01:25 -07:00
description : 'The external identifier to set to this member' ,
2021-02-20 09:55:57 -08:00
default : '' ,
} ,
] ,
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'create' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
// ----------------------------------
// member: update
// ----------------------------------
{
displayName : 'Update Fields' ,
name : 'updateFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
options : [
{
displayName : 'Type' ,
name : 'type' ,
type : 'options' ,
default : { } ,
options : [
{
name : 'Owner' ,
value : 0 ,
} ,
{
name : 'Admin' ,
value : 1 ,
} ,
{
name : 'User' ,
value : 2 ,
} ,
{
name : 'Manager' ,
value : 3 ,
} ,
] ,
} ,
{
2022-06-20 07:54:01 -07:00
displayName : 'Collection Names or IDs' ,
2021-02-20 09:55:57 -08:00
name : 'collections' ,
type : 'multiOptions' ,
2022-08-01 13:47:55 -07:00
description :
'The collections to assign to this member. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.' ,
2021-02-20 09:55:57 -08:00
default : [ ] ,
typeOptions : {
loadOptionsMethod : 'getCollections' ,
} ,
} ,
{
displayName : 'External ID' ,
name : 'externalId' ,
type : 'string' ,
2022-05-06 14:01:25 -07:00
description : 'The external identifier to set to this member' ,
2021-02-20 09:55:57 -08:00
default : '' ,
} ,
{
displayName : 'Access All' ,
name : 'accessAll' ,
type : 'boolean' ,
default : false ,
} ,
] ,
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'update' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
// ----------------------------------
// member: updateGroups
// ----------------------------------
{
displayName : 'Group IDs' ,
name : 'groupIds' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'Comma-separated list of IDs of groups to set for a member' ,
2021-02-20 09:55:57 -08:00
displayOptions : {
show : {
2022-08-01 13:47:55 -07:00
resource : [ 'member' ] ,
operation : [ 'updateGroups' ] ,
2021-02-20 09:55:57 -08:00
} ,
} ,
} ,
2021-12-03 00:44:16 -08:00
] ;
2021-02-20 09:55:57 -08:00
type MemberSchema = {
email : string ;
collections : string [ ] ;
type : number ;
accessAll : boolean ;
externalId : string ;
} ;
export type MemberUpdateFields = Omit < MemberSchema , ' email ' > ;
export type MemberCreationAdditionalFields = Omit < MemberSchema , ' email ' > ;