@heines/n8n-nodes-pax8 0.1.0

package/README.md

@@ -0,0 +1,53 @@
+# @heines/n8n-nodes-pax8
+
+Community node for the **Pax8 Partner API**.
+
+This package contains:
+- **Pax8** node (common resources + a generic *API Request* operation)
+- **Pax8 OAuth2 (Client Credentials)** credential (recommended)
+- **Pax8 API Token** credential (paste an access token)
+
+> Generated from the provided OpenAPI spec (`nodes/Pax8/openapi.json`).
+
+## Installation (n8n)
+
+### Community nodes (recommended)
+1. In n8n: **Settings → Community Nodes**
+2. Install: `@heines/n8n-nodes-pax8`
+
+### Manual
+```bash
+npm install @heines/n8n-nodes-pax8
+```
+
+## Credentials
+
+### OAuth2 (Client Credentials)
+Use the **Pax8 OAuth2 (Client Credentials)** credential:
+- Client ID / Client Secret
+- Token URL: `https://token-manager.pax8.com/oauth/token`
+- Audience: `https://api.pax8.com`
+
+### Access Token
+If you already have an access token, use **Pax8 API Token** and paste it.
+
+## Node usage
+
+### Generic API request
+Use **Resource: API → Operation: Request** to call *any* endpoint in the OpenAPI spec.
+- Endpoint supports `{param}` placeholders (e.g. `/companies/{companyId}`) + Path Parameters.
+- Query Parameters and JSON Body supported.
+
+### Included shortcuts
+A first set of common shortcuts is included:
+- Companies, Contacts, Products, Orders, Subscriptions, Invoices, Usage Summaries, Provisioners
+
+## Development
+
+```bash
+npm install
+npm run build
+```
+
+## Disclaimer
+This is an unofficial community node. Pax8 is a trademark of Pax8, Inc.

package/dist/credentials/Pax8ApiToken.credentials.d.ts

@@ -0,0 +1,7 @@
+import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class Pax8ApiToken implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/Pax8ApiToken.credentials.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pax8ApiToken = void 0;
+class Pax8ApiToken {
+    constructor() {
+        this.name = 'pax8ApiToken';
+        this.displayName = 'Pax8 API Token';
+        this.documentationUrl = 'https://developer.pax8.com/'; // adjust if different
+        this.properties = [
+            {
+                displayName: 'Access Token',
+                name: 'accessToken',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Bearer access token for the Pax8 API.',
+            },
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: 'https://api.pax8.com',
+                required: true,
+            },
+        ];
+    }
+}
+exports.Pax8ApiToken = Pax8ApiToken;

package/dist/credentials/Pax8OAuth2Api.credentials.d.ts

@@ -0,0 +1,8 @@
+import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class Pax8OAuth2Api implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    extends: string[];
+    properties: INodeProperties[];
+}

package/dist/credentials/Pax8OAuth2Api.credentials.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pax8OAuth2Api = void 0;
+class Pax8OAuth2Api {
+    constructor() {
+        this.name = 'pax8OAuth2Api';
+        this.displayName = 'Pax8 OAuth2 (Client Credentials)';
+        this.documentationUrl = 'https://developer.pax8.com/'; // adjust if different
+        this.extends = ['oAuth2Api'];
+        this.properties = [
+            {
+                displayName: 'Client ID',
+                name: 'clientId',
+                type: 'string',
+                default: '',
+                required: true,
+            },
+            {
+                displayName: 'Client Secret',
+                name: 'clientSecret',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+            },
+            {
+                displayName: 'Token URL',
+                name: 'accessTokenUrl',
+                type: 'string',
+                default: 'https://token-manager.pax8.com/oauth/token',
+                required: true,
+            },
+            {
+                displayName: 'Audience',
+                name: 'audience',
+                type: 'string',
+                default: 'https://api.pax8.com',
+                description: 'Pax8 API audience to request in the token call.',
+                required: true,
+            },
+            {
+                displayName: 'Scope',
+                name: 'scope',
+                type: 'string',
+                default: '',
+                description: 'Optional. Leave blank unless Pax8 provided you scopes.',
+            },
+            {
+                displayName: 'Grant Type',
+                name: 'grantType',
+                type: 'hidden',
+                default: 'clientCredentials',
+            },
+            {
+                displayName: 'Authentication',
+                name: 'authentication',
+                type: 'hidden',
+                default: 'body',
+            },
+        ];
+    }
+}
+exports.Pax8OAuth2Api = Pax8OAuth2Api;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './nodes/Pax8/Pax8.node';
+export * from './credentials/Pax8OAuth2Api.credentials';
+export * from './credentials/Pax8ApiToken.credentials';

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./nodes/Pax8/Pax8.node"), exports);
+__exportStar(require("./credentials/Pax8OAuth2Api.credentials"), exports);
+__exportStar(require("./credentials/Pax8ApiToken.credentials"), exports);

package/dist/nodes/Pax8/Pax8.node.d.ts

@@ -0,0 +1,37 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription, ILoadOptionsFunctions } from 'n8n-workflow';
+export declare class Pax8 implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getCompanies(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: any;
+            }[]>;
+            getProducts(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: any;
+            }[]>;
+            getSubscriptions(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: any;
+            }[]>;
+            getInvoices(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: any;
+            }[]>;
+            getQuotes(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: any;
+            }[]>;
+            getWebhooks(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: any;
+            }[]>;
+            getContacts(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: any;
+            }[]>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}