n8n-nodes-netsapiens 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 David Szpunar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# n8n-nodes-netsapiens
+
+This is an n8n community node. It lets you interact with the NetSapiens API in your n8n workflows.
+
+NetSapiens is a Voice over IP (VoIP) phone switch software provider that provides a REST API (the `ns-api`) that can be used to manage and query resources in a NetSapiens environment.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/sustainable-use-license/) workflow automation platform.
+
+[Installation](#installation)
+[Operations](#operations)
+[Credentials](#credentials)
+[Compatibility](#compatibility)
+[Usage](#usage)
+[Resources](#resources)
+[Version history](#version-history)
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+This node is primarily driven by a bundled OpenAPI specification. In most cases you:
+
+- **Select a resource** (an API grouping)
+- **Select an operation** (an API endpoint action)
+
+The node then renders fields for the endpoint parameters.
+
+In addition, the node includes a **Raw -> Request** operation that lets you call arbitrary endpoints directly when you need full control.
+
+NetSapiens provides the [API JSON Schema](https://docs.ns-api.com/docs/download-full-api-json-schema-file) as part of their documentation, which this node uses to generate the basic node interface. The node also implements a number of overrides to handle NetSapiens-specific details and add additional functionality and affordances.
+
+Read operations are substantially better tested and usable than write calls, which may require build custom JSON objects for crate and update requests initially.
+
+## Credentials
+
+Create a new **NetSapiens API** credential. This node is designed for [API Keys](https://docs.ns-api.com/docs/api-keys) (bearer tokens) only, not refresh/access tokens or other authentication methods. Oauth Access Tokens and JWT Tokens are not supported, nor does NetSapiens provide documentation for these in version 2 of the API.
+
+Only NetSapiens API version 2 supports API keys, and this node only connects to API version 2 endpoints (though the API key would be valid for API version 1 as well, for versions of NetSapiens that support API version 2 credentials).
+
+- **Server**: Your NetSapiens API hostname (without protocol)
+- **Bearer Token**: An API key (bearer token) used for API requests
+- **Base URL** (optional): Override the full base URL. If empty, the node defaults to `https://{server}/ns-api/v2`.
+
+Obtain an API key from your NetSapiens provider if you are a Reseller user, or obtain the API key directly from your NetSapiens instance if you have administrator access.
+
+NetSapiens, as of this writing, runs a [Developer Sandbox](https://docs.ns-api.com/docs/developer-sandbox-ns-apicom) where you can test API usage if you would like.
+
+NetSapiens provides an [API v1 Migration to v2 reference](https://docs.ns-api.com/docs/v1-migration-to-v2) to review so you can determine differences between the API versions if you're familiar with version 1.
+
+## Compatibility
+
+- **Minimum n8n version**: Developed and tested with version `2.0.3+` but will likely work with several prior versions.
+- **Tested with**: Local development via `n8n-node dev`
+- **Tested with**: NetSapiens Version 44.3.2
+
+**Note:** The OpenAPI spec used to implement this node is not from a well-defined version, though it's older than 45.0 and likely is for a version of 44.x when API v2 was introduced. The 45.0 spec provided by NetSapiens has a substantial numer of changes and additions and this node may not be fully compatible with it until it's updated in the future (however, you can use the Raw API Request option to make calls to endpoints that are not yet implemented).
+
+## Usage
+
+### Basic usage
+
+- **Resource**: Select an API resource grouping.
+- **Operation**: Select the specific endpoint action.
+- **Parameters**:
+	- Path and query parameters appear as node fields.
+	- If the endpoint has a request body, a **Body** JSON field is shown.
+
+### Raw request
+
+If you need an endpoint that is not represented (or you want full control), use the Raw API request:
+
+- **Resource**: `Raw`
+- **Operation**: `Raw API Request`
+
+Then set:
+
+- **Method**
+- **Endpoint** (for example: `/domains`)
+- **Query Parameters**
+- **Body** (for non-GET/non-DELETE requests)
+
+### Development
+
+From `n8n-nodes-netsapiens/`:
+
+- `npm install` installs dependencies.
+- `npm run generate` regenerates `generated/openapi.ts` from `openapi/NetSapiens.v2.3.1.0.openapi.json`.
+- `npm run build` runs code generation and builds the node.
+- `npm run dev` runs the node in development mode directly, launching n8n, or:
+- Use `npm link` to link the node to n8n (and then `npm link n8n-nodes-netsapiens` in your n8n instance `config` directory and restart n8n).
+
+### Notes / open questions
+
+Please confirm your preference for the following behaviors:
+
+- Whether Authentication resources/actions should be hidden by default in the node UI.
+- Whether `Raw -> Request` should remain the default resource/operation (or whether a specific resource/operation should be the default).
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+* [NetSapiens API documentation](https://docs.ns-api.com/)
+* There's a public [NetSapiens MCP server](https://docs.ns-api.com/v45.0/docs/mcp-1) starting with version 45.0 for testing at `https://docs.ns-api.com/mcp?branch=45.0`. No authentication is required.
+
+## Changelog
+
+For a version history of changes and updates, see the [CHANGELOG.md](CHANGELOG.md) file.
+
+## TODO
+
+See [TODO.md](TODO.md).
+
+## Attribution
+
+NetSapiens is A Crexendo Company and they own the trademarks and intellectual property rights to the NetSapiens brand. This node is not affiliated with NetSapiens or Crexendo in any way and is provided as a service to the n8n community.
+
+## License
+
+MIT

package/dist/credentials/NetSapiensApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import type { IAuthenticateGeneric, Icon, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class NetSapiensApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    icon: Icon;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/NetSapiensApi.credentials.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetSapiensApi = void 0;
+class NetSapiensApi {
+    constructor() {
+        this.name = 'netSapiensApi';
+        this.displayName = 'NetSapiens API';
+        this.icon = {
+            light: 'file:../nodes/NetSapiens/NetSapiens.svg',
+            dark: 'file:../nodes/NetSapiens/NetSapiens.dark.svg',
+        };
+        this.documentationUrl = 'https://github.com/<...>/n8n-nodes-<...>?tab=readme-ov-file#credentials';
+        this.properties = [
+            {
+                displayName: 'Server',
+                name: 'server',
+                type: 'string',
+                default: '',
+                description: 'Hostname for your NetSapiens environment (without protocol)',
+                required: true,
+                placeholder: 'example.netsapiens.com',
+            },
+            {
+                displayName: 'Bearer Token',
+                name: 'bearerToken',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+            },
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: '',
+                description: 'Optional override. If empty, https://{server}/ns-api/v2 is used.',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '={{"Bearer " + $credentials.bearerToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.baseUrl ? $credentials.baseUrl : ("https://" + $credentials.server + "/ns-api/v2")}}',
+                url: '/domains',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.NetSapiensApi = NetSapiensApi;
+//# sourceMappingURL=NetSapiensApi.credentials.js.map

package/dist/credentials/NetSapiensApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetSapiensApi.credentials.js","sourceRoot":"","sources":["../../credentials/NetSapiensApi.credentials.ts"],"names":[],"mappings":";;;AAQA,MAAa,aAAa;IAA1B;QACC,SAAI,GAAG,eAAe,CAAC;QAEvB,gBAAW,GAAG,gBAAgB,CAAC;QAE/B,SAAI,GAAS;YACZ,KAAK,EAAE,yCAAyC;YAChD,IAAI,EAAE,8CAA8C;SACpD,CAAC;QAEF,qBAAgB,GAAG,yEAAyE,CAAC;QAE7F,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,QAAQ;gBACrB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,6DAA6D;gBAC1E,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,wBAAwB;aACrC;YACD;gBACC,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;aACd;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,kEAAkE;aAC/E;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,2CAA2C;iBAC1D;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EACN,sGAAsG;gBACvG,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AA1DD,sCA0DC"}

package/dist/generated/openapi.d.ts

@@ -0,0 +1,22 @@
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE';
+export type ParameterLocation = 'path' | 'query' | 'header';
+export type GeneratedOpenApiParameter = {
+    name: string;
+    in: ParameterLocation;
+    required: boolean;
+    description?: string;
+    schemaType?: string;
+};
+export type GeneratedOpenApiOperation = {
+    id: string;
+    method: HttpMethod;
+    path: string;
+    resource: string;
+    summary?: string;
+    description?: string;
+    parameters: GeneratedOpenApiParameter[];
+    hasRequestBody: boolean;
+};
+export declare const resources: readonly string[];
+export declare const operations: readonly GeneratedOpenApiOperation[];
+export declare const operationMap: Record<string, GeneratedOpenApiOperation>;