@openfn/language-maximo 0.5.10 → 0.5.12

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.
Files changed (3) hide show
  1. package/ast.json +4 -2
  2. package/package.json +2 -3
  3. package/types/Adaptor.d.ts +10 -13
package/ast.json CHANGED
@@ -53,7 +53,8 @@
53
53
  "tags": [
54
54
  {
55
55
  "title": "example",
56
- "description": "execute(\n update(params)\n)(state)"
56
+ "description": "update({\n endpoint: \"maxrest/rest/mbo/workorder/1234\",\n body: state => state.data,\n});",
57
+ "caption": "Update a workorder"
57
58
  },
58
59
  {
59
60
  "title": "function",
@@ -96,7 +97,8 @@
96
97
  "tags": [
97
98
  {
98
99
  "title": "example",
99
- "description": "execute(\n update75(params)\n)(state)"
100
+ "description": "update75({\n endpoint: \"maxrest/rest/mbo/invbalances\",\n body: state => state.inventoryBalances,\n});",
101
+ "caption": "Update an inventory balance"
100
102
  },
101
103
  {
102
104
  "title": "function",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfn/language-maximo",
3
- "version": "0.5.10",
3
+ "version": "0.5.12",
4
4
  "description": "An IBM Maximo EAM Language Pack for OpenFn",
5
5
  "main": "dist/index.cjs",
6
6
  "author": "Open Function Group",
@@ -15,10 +15,9 @@
15
15
  "base-64": "^0.1.0",
16
16
  "request": "^2.88.2",
17
17
  "utf8": "^2.1.2",
18
- "@openfn/language-common": "2.2.1"
18
+ "@openfn/language-common": "2.3.0"
19
19
  },
20
20
  "devDependencies": {
21
- "@openfn/simple-ast": "0.4.1",
22
21
  "assertion-error": "^2.0.0",
23
22
  "babel-cli": "^6.26.0",
24
23
  "babel-core": "^6.26.3",
package/types/Adaptor.d.ts CHANGED
@@ -1,11 +1,6 @@
1
1
  /**
2
2
  * Execute a sequence of operations.
3
3
  * Wraps `@openfn/language-common/execute`, and prepends initial state for http.
4
- * @example
5
- * execute(
6
- * create('foo'),
7
- * delete('bar')
8
- * )(state)
9
4
  * @private
10
5
  * @param {Operations} operations - Operations to be performed.
11
6
  * @returns {Operation}
@@ -31,10 +26,11 @@ export function fetch(params: object): Operation;
31
26
  export function create(params: any): (state: any) => Promise<any>;
32
27
  /**
33
28
  * Make an update in Maximo 7.6 and beyond
34
- * @example
35
- * execute(
36
- * update(params)
37
- * )(state)
29
+ * @example <caption>Update a workorder</caption>
30
+ * update({
31
+ * endpoint: "maxrest/rest/mbo/workorder/1234",
32
+ * body: state => state.data,
33
+ * });
38
34
  * @function
39
35
  * @public
40
36
  * @param {object} params - data to make the update
@@ -43,10 +39,11 @@ export function create(params: any): (state: any) => Promise<any>;
43
39
  export function update(params: object): Operation;
44
40
  /**
45
41
  * Make an upadte in Maximo 7.5
46
- * @example
47
- * execute(
48
- * update75(params)
49
- * )(state)
42
+ * @example <caption>Update an inventory balance</caption>
43
+ * update75({
44
+ * endpoint: "maxrest/rest/mbo/invbalances",
45
+ * body: state => state.inventoryBalances,
46
+ * });
50
47
  * @function
51
48
  * @public
52
49
  * @param {object} params - data to make the update