@disruptive-learning/n8n-nodes-gigstack 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Gigstack
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,81 @@
1
+ # @disruptive-learning/n8n-nodes-gigstack
2
+
3
+ This is a community node for [n8n](https://n8n.io/) that integrates with the [Gigstack API](https://gigstack.com). It allows you to create and manage payments and invoices directly from your n8n workflows.
4
+
5
+ [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
6
+
7
+ [Installation](#installation)
8
+ [Operations](#operations)
9
+ [Credentials](#credentials)
10
+ [Compatibility](#compatibility)
11
+ [Resources](#resources)
12
+ [Version history](#version-history)
13
+ [Security](#security)
14
+
15
+ ## Installation
16
+
17
+ Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
18
+
19
+ ### Community Node Installation
20
+
21
+ 1. Open your n8n instance
22
+ 2. Go to **Settings** > **Community Nodes**
23
+ 3. Select **Install**
24
+ 4. Enter `@disruptive-learning/n8n-nodes-gigstack` in **Enter npm package name**
25
+ 5. Agree to the risks of using community nodes: select **I understand the risks of installing unverified code from a third party**
26
+ 6. Select **Install**
27
+
28
+ After installing the node, you can use it like any other node. If you're using Docker, you need to restart your n8n container for the node to show up.
29
+
30
+ ## Operations
31
+
32
+ ### Payment Operations
33
+
34
+ - **Create**: Create a new payment
35
+ - **Get**: Get payment details
36
+ - **Register**: Register a new payment
37
+
38
+ ### Invoice Operations
39
+
40
+ - **Create**: Create a new invoice with detailed information
41
+
42
+ ## Credentials
43
+
44
+ To use this node, you need to configure your Gigstack API credentials in n8n:
45
+
46
+ 1. Go to **Settings** > **Credentials**
47
+ 2. Click on **New Credential**
48
+ 3. Select **Gigstack API**
49
+ 4. Enter your API Key
50
+ 5. Select the environment (Production or Sandbox)
51
+ 6. Save the credential
52
+
53
+ ## Compatibility
54
+
55
+ This node has been tested with n8n version 0.214.0 and Gigstack API v1.
56
+
57
+ ## Resources
58
+
59
+ - [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
60
+ - [Gigstack API documentation](https://docs.gigstack.com)
61
+
62
+ ## Security
63
+
64
+ > **Note**: This package has some vulnerabilities in its development dependencies. These vulnerabilities are only present during development and do not affect the published package that users install. The production dependencies are kept up-to-date and secure.
65
+
66
+ ## Version history
67
+
68
+ ### 1.1.1
69
+
70
+ - [Add description of changes in this version]
71
+
72
+ ### 1.1.0
73
+
74
+ - Added Invoice resource with Create operation
75
+ - Fixed Get Payment operation to use correct API endpoint
76
+ - Updated node version to 2
77
+
78
+ ### 1.0.0
79
+
80
+ - Initial release
81
+ - Added Payment resource with Create, Get, and Register operations
@@ -0,0 +1,8 @@
1
+ import { IAuthenticateGeneric, ICredentialType, INodeProperties } from "n8n-workflow";
2
+ export declare class GigstackApi implements ICredentialType {
3
+ name: string;
4
+ displayName: string;
5
+ documentationUrl: string;
6
+ properties: INodeProperties[];
7
+ authenticate: IAuthenticateGeneric;
8
+ }
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.GigstackApi = void 0;
4
+ class GigstackApi {
5
+ constructor() {
6
+ this.name = "gigstackApi";
7
+ this.displayName = "Gigstack API";
8
+ this.documentationUrl = "https://github.com/disruptive-learning/gigstack_n8n/blob/main/README.md#credentials";
9
+ this.properties = [
10
+ {
11
+ displayName: "API Key",
12
+ name: "apiKey",
13
+ type: "string",
14
+ typeOptions: {
15
+ password: true,
16
+ },
17
+ default: "",
18
+ },
19
+ {
20
+ displayName: "Environment",
21
+ name: "environment",
22
+ type: "options",
23
+ options: [
24
+ {
25
+ name: "Production",
26
+ value: "production",
27
+ },
28
+ {
29
+ name: "Sandbox",
30
+ value: "sandbox",
31
+ },
32
+ ],
33
+ default: "production",
34
+ },
35
+ ];
36
+ this.authenticate = {
37
+ type: "generic",
38
+ properties: {
39
+ headers: {
40
+ Authorization: "=Bearer {{$credentials.apiKey}}",
41
+ },
42
+ },
43
+ };
44
+ }
45
+ }
46
+ exports.GigstackApi = GigstackApi;
@@ -0,0 +1,5 @@
1
+ import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from "n8n-workflow";
2
+ export declare class Gigstack implements INodeType {
3
+ description: INodeTypeDescription;
4
+ execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
5
+ }