n8n-nodes-arubacentral/dist/nodes/ArubaCentral/api/firmware/swarm/operations/getSwarms.methods.ts

n8n community node for Aruba Central API integration with comprehensive monitoring, configuration, and management capabilities

import { IExecuteFunctions, INodeExecutionData, IDataObject } from 'n8n-workflow';
import { apiRequest } from '../../../../helpers/apiRequest';
import { logger } from '../../../../helpers/logger';
import { handleApiError } from '../../../../helpers/errorHandler';
import { handlePagination } from '../../../../helpers/pagination';
import { validateSwarmsResponse } from '../swarm.types';

/**
 * Retrieves a list of swarms with their firmware details
 * GET /firmware/v1/swarms
 *
 * @param this The n8n execution context
 * @returns List of swarms with firmware details
 */
export async function getSwarms(this: IExecuteFunctions): Promise<INodeExecutionData[]> {
	try {
		// Get parameters
		const returnAll = this.getNodeParameter('returnAll', 0, false) as boolean;
		const limit = returnAll ? 0 : (this.getNodeParameter('limit', 0, 20) as number);

		// Get additional fields
		const additionalFields = this.getNodeParameter('additionalFields', 0, {}) as IDataObject;

		// Construct request options
		const options: IDataObject = {};
		const qs: IDataObject = {};

		// Map UI fields to API parameters
		if (additionalFields.group) {
			qs.group = additionalFields.group;
		}

		options.qs = qs;

		// Handle pagination
		if (returnAll || limit > 0) {
			return await handlePagination.call(
				this,
				'/firmware/v1/swarms',
				'GET',
				{}, // body
				qs,
				{
					path: ['swarms'],
					fallbackPaths: [['data'], ['items']],
				},
				returnAll,
				limit,
				20, // default limit
			);
		}

		// For non-paginated requests
		const responseData = await apiRequest.call(
			this,
			'GET',
			'/firmware/v1/swarms',
			{}, // body
			qs,
		);

		if (!validateSwarmsResponse(responseData)) {
			throw new Error('Invalid response from API');
		}

		return [{ json: responseData as unknown as IDataObject }];
	} catch (error) {
		logger.error('firmware:swarm:getSwarms:error', { message: error.message });
		return handleApiError.call(this, error, 'Failed to retrieve swarms');
	}
}