@lowdefy/connection-stripe 0.0.0-experimental-20250926130521 → 0.0.0-experimental-20251010122007
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.
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
<TITLE>
|
|
2
|
+
StripeRequest
|
|
3
|
+
</TITLE>
|
|
4
|
+
|
|
5
|
+
<DESCRIPTION>
|
|
6
|
+
|
|
7
|
+
The `StripeRequest` request allows calls to all modules supported by the [Stripe API client](https://stripe.com/docs/api?lang=node) by nesting the resource and method calls:
|
|
8
|
+
```yaml
|
|
9
|
+
resource:
|
|
10
|
+
method:
|
|
11
|
+
- parameter1
|
|
12
|
+
- parameter2
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
- `{{ apiResource }}: object`: A Stripe API resource, eg. `customers`.
|
|
18
|
+
- `{{ method }}: array | null`: A resource method, eg. `create`. The arguments array will be passed on to the client method.
|
|
19
|
+
|
|
20
|
+
The Stripe client exposes all resources as objects, with the API methods being available as function properties on those resource objects.
|
|
21
|
+
In Lowdefy, you may access these properties by nesting them.
|
|
22
|
+
|
|
23
|
+
</DESCRIPTION>
|
|
24
|
+
|
|
25
|
+
<CONNECTION>
|
|
26
|
+
Stripe
|
|
27
|
+
</CONNECTION>
|
|
28
|
+
|
|
29
|
+
<SCHEMA>
|
|
30
|
+
|
|
31
|
+
```js
|
|
32
|
+
export default {
|
|
33
|
+
$schema: 'http://json-schema.org/draft-07/schema#',
|
|
34
|
+
title: 'Lowdefy Request Schema - StripeRequest',
|
|
35
|
+
type: 'object',
|
|
36
|
+
patternProperties: {
|
|
37
|
+
'.+': {
|
|
38
|
+
description: 'Stripe API resource',
|
|
39
|
+
type: 'object',
|
|
40
|
+
minProperties: 1,
|
|
41
|
+
maxProperties: 1,
|
|
42
|
+
errorMessage: {
|
|
43
|
+
type: 'StripeRequest resource should be an object.',
|
|
44
|
+
minProperties: 'StripeRequest resource should contain a method to call.',
|
|
45
|
+
maxProperties: 'StripeRequest resource should contain only a single method to call.',
|
|
46
|
+
oneOf:
|
|
47
|
+
'StripeRequest resource should only contain a method to call, or sub-resource with a method to call.',
|
|
48
|
+
},
|
|
49
|
+
oneOf: [
|
|
50
|
+
{
|
|
51
|
+
description: 'Stripe API method to call on the resource',
|
|
52
|
+
patternProperties: {
|
|
53
|
+
'.+': {
|
|
54
|
+
description: 'Parameters to pass to the resource method, if any',
|
|
55
|
+
type: ['array', 'null'],
|
|
56
|
+
errorMessage: {
|
|
57
|
+
type: 'Should be an array of parameters or null.',
|
|
58
|
+
},
|
|
59
|
+
},
|
|
60
|
+
},
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
description: 'Stripe API sub-resource of the parent resource',
|
|
64
|
+
patternProperties: {
|
|
65
|
+
'.+': {
|
|
66
|
+
description: 'Stripe API method to call on the resource',
|
|
67
|
+
type: 'object',
|
|
68
|
+
minProperties: 1,
|
|
69
|
+
maxProperties: 1,
|
|
70
|
+
patternProperties: {
|
|
71
|
+
'.+': {
|
|
72
|
+
description: 'Parameters to pass to the sub-resource method, if any',
|
|
73
|
+
type: ['array', 'null'],
|
|
74
|
+
},
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
},
|
|
78
|
+
},
|
|
79
|
+
],
|
|
80
|
+
},
|
|
81
|
+
},
|
|
82
|
+
minProperties: 1,
|
|
83
|
+
maxProperties: 1,
|
|
84
|
+
errorMessage: {
|
|
85
|
+
type: 'StripeRequest request properties should be an object.',
|
|
86
|
+
additionalProperties: 'StripeRequest should contain a valid resource to call.',
|
|
87
|
+
minProperties: 'StripeRequest should contain a resource to call.',
|
|
88
|
+
maxProperties: 'StripeRequest should contain only a single resource to call.',
|
|
89
|
+
},
|
|
90
|
+
};
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
</SCHEMA>
|
|
94
|
+
|
|
95
|
+
<EXAMPLES>
|
|
96
|
+
|
|
97
|
+
### List the 30 most recent customers
|
|
98
|
+
|
|
99
|
+
```yaml
|
|
100
|
+
requests:
|
|
101
|
+
- id: list_customers
|
|
102
|
+
type: StripeRequest
|
|
103
|
+
connectionId: stripe
|
|
104
|
+
properties:
|
|
105
|
+
customers:
|
|
106
|
+
list:
|
|
107
|
+
limit: 30
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Create a payment intent
|
|
111
|
+
|
|
112
|
+
```yaml
|
|
113
|
+
requests:
|
|
114
|
+
- id: create_payment_intent
|
|
115
|
+
type: StripeRequest
|
|
116
|
+
connectionId: stripe
|
|
117
|
+
properties:
|
|
118
|
+
paymentIntents:
|
|
119
|
+
create:
|
|
120
|
+
- amount: 2000
|
|
121
|
+
currency: eur
|
|
122
|
+
payment_method_types: [ card ]
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Retrieve a checkout session by ID
|
|
126
|
+
|
|
127
|
+
```yaml
|
|
128
|
+
requests:
|
|
129
|
+
- id: retrieve_checkout_session
|
|
130
|
+
type: StripeRequest
|
|
131
|
+
connectionId: stripe
|
|
132
|
+
properties:
|
|
133
|
+
checkout:
|
|
134
|
+
sessions:
|
|
135
|
+
retrieve:
|
|
136
|
+
- cs_test_onpT2icY2lrSU0IgDGXEhhcOHcWeJS5BpLcQGMx0uI9TZHLMBdzvWpvx
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
</EXAMPLES>
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
<TITLE>
|
|
2
|
+
Stripe
|
|
3
|
+
</TITLE>
|
|
4
|
+
|
|
5
|
+
<DESCRIPTION>
|
|
6
|
+
|
|
7
|
+
[Stripe](https://stripe.com/) is a popular payment provider which allows you to accept payments, send payouts, and manage your business online.
|
|
8
|
+
The `Stripe` connector uses the official [Node.js client from Stripe](https://github.com/stripe/stripe-node).
|
|
9
|
+
In order to use the `Stripe` connection, you first need to create a [Stripe](https://stripe.com/) account and setup an API key.
|
|
10
|
+
|
|
11
|
+
> Secrets like API keys should be stored using the [`_secret`](operators/secret.md) operator.
|
|
12
|
+
|
|
13
|
+
### Properties
|
|
14
|
+
|
|
15
|
+
- `secretKey: string`: __Required__ - Stripe [secret key](https://stripe.com/docs/keys).
|
|
16
|
+
- `apiVersion: string`: Stripe API version to use. Defaults to the account-wide version.
|
|
17
|
+
- `timeout: number`: Timeout for requests to the Stripe API.
|
|
18
|
+
- `maxNetworkRetries: number`: Maximum number of times failed requests are repeated before throwing an error.
|
|
19
|
+
- `telemetry: boolean`: Whether to send telemetry data to Stripe (this is forwarded to the Stripe client library. Lowdefy does not receive any telemetry data from your Stripe connection.)
|
|
20
|
+
|
|
21
|
+
</DESCRIPTION>
|
|
22
|
+
|
|
23
|
+
<REQUESTS>
|
|
24
|
+
|
|
25
|
+
- StripeRequest
|
|
26
|
+
|
|
27
|
+
</REQUESTS>
|
|
28
|
+
|
|
29
|
+
<SCHEMA>
|
|
30
|
+
|
|
31
|
+
```js
|
|
32
|
+
export default {
|
|
33
|
+
$schema: 'http://json-schema.org/draft-07/schema#',
|
|
34
|
+
title: 'Lowdefy Connection Schema - Stripe',
|
|
35
|
+
type: 'object',
|
|
36
|
+
required: ['secretKey'],
|
|
37
|
+
properties: {
|
|
38
|
+
secretKey: {
|
|
39
|
+
type: 'string',
|
|
40
|
+
description: 'Stripe secret key.',
|
|
41
|
+
errorMessage: {
|
|
42
|
+
type: 'Stripe connection property "secretKey" should be a string.',
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
apiVersion: {
|
|
46
|
+
type: 'string',
|
|
47
|
+
description: 'Stripe API version to use.',
|
|
48
|
+
default: null,
|
|
49
|
+
errorMessage: {
|
|
50
|
+
type: 'Stripe connection property "apiVersion" should be a string.',
|
|
51
|
+
},
|
|
52
|
+
},
|
|
53
|
+
telemetry: {
|
|
54
|
+
type: 'boolean',
|
|
55
|
+
description: 'Allow Stripe to send latency telemetry.',
|
|
56
|
+
default: true,
|
|
57
|
+
errorMessage: {
|
|
58
|
+
type: 'Stripe connection property "telemetry" should be a boolean.',
|
|
59
|
+
},
|
|
60
|
+
},
|
|
61
|
+
timeout: {
|
|
62
|
+
type: 'integer',
|
|
63
|
+
description: 'Maximum time each request can take in ms.',
|
|
64
|
+
default: 80000,
|
|
65
|
+
errorMessage: {
|
|
66
|
+
type: 'Stripe connection property "timeout" should be an integer.',
|
|
67
|
+
},
|
|
68
|
+
},
|
|
69
|
+
maxNetworkRetries: {
|
|
70
|
+
type: 'integer',
|
|
71
|
+
description: 'The amount of times a request should be retried.',
|
|
72
|
+
default: 0,
|
|
73
|
+
errorMessage: {
|
|
74
|
+
type: 'Stripe connection property "maxNetworkRetries" should be an integer.',
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
},
|
|
78
|
+
errorMessage: {
|
|
79
|
+
type: 'Stripe connection properties should be an object.',
|
|
80
|
+
required: {
|
|
81
|
+
secretKey: 'Stripe connection should have required property "secretKey".',
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
};
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
</SCHEMA>
|
|
88
|
+
|
|
89
|
+
<EXAMPLES>
|
|
90
|
+
|
|
91
|
+
### Simple connection
|
|
92
|
+
|
|
93
|
+
```yaml
|
|
94
|
+
connections:
|
|
95
|
+
- id: stripe
|
|
96
|
+
type: Stripe
|
|
97
|
+
properties:
|
|
98
|
+
secretKey:
|
|
99
|
+
_secret: STRIPE_SECRET_KEY
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Environment variables:
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Using an older API version
|
|
109
|
+
|
|
110
|
+
```yaml
|
|
111
|
+
connections:
|
|
112
|
+
- id: stripe
|
|
113
|
+
type: Stripe
|
|
114
|
+
properties:
|
|
115
|
+
secretKey:
|
|
116
|
+
_secret: STRIPE_SECRET_KEY
|
|
117
|
+
apiVersion: 2017-12-14
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Environment variables:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
</EXAMPLES>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lowdefy/connection-stripe",
|
|
3
|
-
"version": "0.0.0-experimental-
|
|
3
|
+
"version": "0.0.0-experimental-20251010122007",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"description": "",
|
|
6
6
|
"homepage": "https://lowdefy.com",
|
|
@@ -35,12 +35,12 @@
|
|
|
35
35
|
"dist/*"
|
|
36
36
|
],
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@lowdefy/helpers": "0.0.0-experimental-
|
|
38
|
+
"@lowdefy/helpers": "0.0.0-experimental-20251010122007",
|
|
39
39
|
"stripe": "14.5.0"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@jest/globals": "28.1.3",
|
|
43
|
-
"@lowdefy/ajv": "0.0.0-experimental-
|
|
43
|
+
"@lowdefy/ajv": "0.0.0-experimental-20251010122007",
|
|
44
44
|
"@swc/cli": "0.1.63",
|
|
45
45
|
"@swc/core": "1.3.99",
|
|
46
46
|
"@swc/jest": "0.2.29",
|