n8n/packages/nodes-base/nodes/HomeAssistant/StateDescription.ts

188 lines
3.5 KiB
TypeScript
Raw Normal View History

import {
INodeProperties
} from 'n8n-workflow';
export const stateOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'state',
],
},
},
options: [
{
name: 'Create or update',
value: 'upsert',
description: 'Create a new record, or update the current one if it already exists (upsert)',
},
{
name: 'Get',
value: 'get',
description: 'Get a state for a specific entity',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all states',
},
],
default: 'get',
description: 'The operation to perform.',
},
];
export const stateFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* state:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Entity ID',
name: 'entityId',
type: 'string',
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'state',
],
},
},
required: true,
default: '',
description: 'The entity ID.',
},
/* -------------------------------------------------------------------------- */
/* state:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'state',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'state',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
/* -------------------------------------------------------------------------- */
/* state:upsert */
/* -------------------------------------------------------------------------- */
{
displayName: 'Entity ID',
name: 'entityId',
type: 'string',
displayOptions: {
show: {
operation: [
'upsert',
],
resource: [
'state',
],
},
},
required: true,
default: '',
description: 'The entity ID for which a state will be created.',
},
{
displayName: 'State',
name: 'state',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'state',
],
operation: [
'upsert',
],
},
},
},
{
displayName: 'State Attributes',
name: 'stateAttributes',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
placeholder: 'Add Attribute',
default: {},
displayOptions: {
show: {
resource: [
'state',
],
operation: [
'upsert',
],
},
},
options: [
{
displayName: 'Attributes',
name: 'attributes',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the attribute.',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the attribute.',
},
],
},
],
},
];