@openfn/language-beyonic 0.1.6 → 0.1.8
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/README.md +44 -39
- package/configuration-schema.json +8 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,66 +1,71 @@
|
|
|
1
|
-
Language Beyonic
|
|
2
|
-
================
|
|
1
|
+
# Language Beyonic
|
|
3
2
|
|
|
4
|
-
Language Pack for building expressions and operations for working with
|
|
5
|
-
|
|
3
|
+
Language Pack for building expressions and operations for working with the
|
|
4
|
+
[beyonic API](http://apidocs.beyonic.com/).
|
|
6
5
|
|
|
7
|
-
Documentation
|
|
8
|
-
-------------
|
|
6
|
+
## Documentation
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
### Configuration
|
|
11
9
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
}
|
|
17
|
-
```
|
|
10
|
+
View all the required and optional properties for `state.configuration` in the
|
|
11
|
+
official
|
|
12
|
+
[configuration-schema](https://docs.openfn.org/adaptors/packages/beyonic-configuration-schema/)
|
|
13
|
+
definition.
|
|
18
14
|
|
|
19
15
|
## Payments API
|
|
20
16
|
|
|
21
17
|
#### `createPayment(...)`
|
|
18
|
+
|
|
22
19
|
```js
|
|
23
|
-
createPayment(
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
)
|
|
20
|
+
createPayment(
|
|
21
|
+
fields(
|
|
22
|
+
field('phonenumber', '+256773712831'),
|
|
23
|
+
field('first_name', 'Gideon'),
|
|
24
|
+
field('last_name', 'Zelalem'),
|
|
25
|
+
field('amount', 100.2),
|
|
26
|
+
field('currency', 'USD'),
|
|
27
|
+
field('account', 1),
|
|
28
|
+
field('description', 'Long-term contract for Arseal'),
|
|
29
|
+
field('payment_type', 'money'),
|
|
30
|
+
field('callback_url', 'https://my.website/payments/callback')
|
|
31
|
+
)
|
|
32
|
+
);
|
|
34
33
|
```
|
|
35
34
|
|
|
36
35
|
## Collection Requests API
|
|
37
36
|
|
|
38
37
|
#### `createCollectionRequest(...)`
|
|
38
|
+
|
|
39
39
|
```js
|
|
40
|
-
createCollectionRequest(
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
)
|
|
40
|
+
createCollectionRequest(
|
|
41
|
+
fields(
|
|
42
|
+
field('instructions', 'Send me some money, please!'),
|
|
43
|
+
field('phonenumber', '+256773712831'),
|
|
44
|
+
field('amount', 5.0),
|
|
45
|
+
field('currency', 'USD')
|
|
46
|
+
)
|
|
47
|
+
);
|
|
46
48
|
```
|
|
47
49
|
|
|
48
50
|
## Contacts API
|
|
49
51
|
|
|
50
52
|
#### `createContact(...)`
|
|
53
|
+
|
|
51
54
|
```js
|
|
52
|
-
createContact(
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
)
|
|
55
|
+
createContact(
|
|
56
|
+
fields(
|
|
57
|
+
field('first_name', 'Granit'),
|
|
58
|
+
field('last_name', 'Xhaka'),
|
|
59
|
+
field('phone_number', '+256773712831'),
|
|
60
|
+
field('email', 'granit@arsenal.com')
|
|
61
|
+
)
|
|
62
|
+
);
|
|
58
63
|
```
|
|
59
64
|
|
|
60
|
-
Development
|
|
61
|
-
-----------
|
|
65
|
+
## Development
|
|
62
66
|
|
|
63
|
-
Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
|
|
67
|
+
Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
|
|
68
|
+
`Getting Started` guide inside to get set up.
|
|
64
69
|
|
|
65
70
|
Run tests using `pnpm run test` or `pnpm run test:watch`
|
|
66
71
|
|
|
@@ -6,13 +6,19 @@
|
|
|
6
6
|
"type": "string",
|
|
7
7
|
"description": "API URL",
|
|
8
8
|
"format": "uri",
|
|
9
|
-
"minLength": 1
|
|
9
|
+
"minLength": 1,
|
|
10
|
+
"examples": [
|
|
11
|
+
"https://beyonic.com/api"
|
|
12
|
+
]
|
|
10
13
|
},
|
|
11
14
|
"apiToken": {
|
|
12
15
|
"title": "API Token",
|
|
13
16
|
"type": "string",
|
|
14
17
|
"description": "API token",
|
|
15
|
-
"minLength": 1
|
|
18
|
+
"minLength": 1,
|
|
19
|
+
"examples": [
|
|
20
|
+
"cdjhiooiSIUJHDYSYUIHASIOHKAANOAJJjsiujhaka"
|
|
21
|
+
]
|
|
16
22
|
}
|
|
17
23
|
},
|
|
18
24
|
"type": "object",
|