n8n/packages/nodes-base/nodes/Affinity/OrganizationDescription.ts

import { INodeProperties } from 'n8n-workflow';

export const organizationOperations = [
	{
		displayName: 'Operation',
		name: 'operation',
		type: 'options',
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
			},
		},
		options: [
			{
				name: 'Create',
				value: 'create',
				description: 'Create an organization',
			},
			{
				name: 'Delete',
				value: 'delete',
				description: 'Delete an organization',
			},
			{
				name: 'Get',
				value: 'get',
				description: 'Get an organization',
			},
			{
				name: 'Get All',
				value: 'getAll',
				description: 'Get all organizations',
			},
			{
				name: 'Update',
				value: 'update',
				description: 'Update an organization',
			},
		],
		default: 'create',
		description: 'The operation to perform.',
	},
] as INodeProperties[];

export const organizationFields = [

/* -------------------------------------------------------------------------- */
/*                                organization:create                               */
/* -------------------------------------------------------------------------- */
	{
		displayName: 'Name',
		name: 'name',
		type: 'string',
		required: true,
		default: '',
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'create',
				]
			},
		},
		description: 'The name of the organization.',
	},
	{
		displayName: 'Domain',
		name: 'domain',
		type: 'string',
		required: true,
		default: '',
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'create',
				]
			},
		},
		description: 'The domain name of the organization.',
	},
	{
		displayName: 'Additional Fields',
		name: 'additionalFields',
		type: 'collection',
		placeholder: 'Add Field',
		default: {},
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'create',
				],
			},
		},
		options: [
			{
				displayName: 'Persons',
				name: 'persons',
				type: 'multiOptions',
				typeOptions: {
					loadOptionsMethod: 'getPersons',
				},
				default: [],
				description: 'Persons that the new organization will be associated with.',
			},
		],
	},
/* -------------------------------------------------------------------------- */
/*                                 organization:update                        */
/* -------------------------------------------------------------------------- */
	{
		displayName: 'Organization ID',
		name: 'organizationId',
		type: 'string',
		required: true,
		default: '',
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'update',
				]
			},
		},
		description: 'Unique identifier for the organization.',
	},
	{
		displayName: 'Update Fields',
		name: 'updateFields',
		type: 'collection',
		placeholder: 'Add Field',
		default: {},
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'update',
				],
			},
		},
		options: [
			{
				displayName: 'Domain',
				name: 'domain',
				type: 'string',
				default: '',
				description: 'The domain name of the organization.',
			},
			{
				displayName: 'Name',
				name: 'name',
				type: 'string',
				default: '',
				description: 'The name of the organization.',
			},
			{
				displayName: 'Persons',
				name: 'persons',
				type: 'multiOptions',
				typeOptions: {
					loadOptionsMethod: 'getPersons',
				},
				default: [],
				description: 'Persons that the new organization will be associated with.',
			},
		]
	},
/* -------------------------------------------------------------------------- */
/*                                 organization:get                           */
/* -------------------------------------------------------------------------- */
	{
		displayName: 'Organization ID',
		name: 'organizationId',
		type: 'string',
		required: true,
		default: '',
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'get',
				]
			},
		},
		description: 'Unique identifier for the organization.',
	},
	{
		displayName: 'Options',
		name: 'options',
		type: 'collection',
		placeholder: 'Add Option',
		default: {},
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'get',
				],
			},
		},
		options: [
			{
				displayName: 'With Interaction Dates',
				name: 'withInteractionDates',
				type: 'boolean',
				default: false,
				description: 'When true, interaction dates will be present on the returned resources.',
			},
		]
	},
/* -------------------------------------------------------------------------- */
/*                                 organization:getAll                        */
/* -------------------------------------------------------------------------- */
	{
		displayName: 'Return All',
		name: 'returnAll',
		type: 'boolean',
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				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: [
					'organization',
				],
				operation: [
					'getAll',
				],
				returnAll: [
					false,
				],
			},
		},
		typeOptions: {
			minValue: 1,
			maxValue: 10,
		},
		default: 5,
		description: 'How many results to return.',
	},
	{
		displayName: 'Options',
		name: 'options',
		type: 'collection',
		placeholder: 'Add Option',
		default: {},
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'getAll',
				],
			},
		},
		options: [
			{
				displayName: 'Term',
				name: 'term',
				type: 'string',
				default: '',
				description: 'A string used to search all the organizations in your team’s address book. This could be an email address, a first name or a last name.',
			},
			{
				displayName: 'With Interaction Dates',
				name: 'withInteractionDates',
				type: 'boolean',
				default: false,
				description: 'When true, interaction dates will be present on the returned resources.',
			},
		]
	},
/* -------------------------------------------------------------------------- */
/*                                 organization:delete                        */
/* -------------------------------------------------------------------------- */
	{
		displayName: 'Organization ID',
		name: 'organizationId',
		type: 'string',
		required: true,
		default: '',
		displayOptions: {
			show: {
				resource: [
					'organization',
				],
				operation: [
					'delete',
				]
			},
		},
		description: 'Unique identifier for the organization.',
	},
] as INodeProperties[];