n8n/packages/nodes-base/nodes/Oura/SummaryDescription.ts

106 lines
1.9 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const summaryOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'summary',
],
},
},
options: [
{
name: 'Get Activity Summary',
value: 'getActivity',
description: 'Get the user\'s activity summary.',
},
{
name: 'Get Readiness Summary',
value: 'getReadiness',
description: 'Get the user\'s readiness summary.',
},
{
name: 'Get Sleep Periods',
value: 'getSleep',
description: 'Get the user\'s sleep summary.',
},
],
default: 'getSleep',
description: 'Operation to perform.',
},
];
export const summaryFields: INodeProperties[] = [
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'summary',
],
},
},
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: [
'summary',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 10,
},
default: 5,
description: 'How many results to return.',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
displayOptions: {
show: {
resource: [
'summary',
],
},
},
default: {},
options: [
{
displayName: 'End Date',
name: 'end',
type: 'dateTime',
default: '',
description: 'End date for the summary retrieval. If omitted, it defaults to the current day.',
},
{
displayName: 'Start Date',
name: 'start',
type: 'dateTime',
default: '',
description: 'Start date for the summary retrieval. If omitted, it defaults to a week ago.',
},
],
},
];