@cxtms/cx-schema 1.9.32 → 1.9.33

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cxtms/cx-schema",
3
- "version": "1.9.32",
3
+ "version": "1.9.33",
4
4
  "description": "Schema validation package for CXTMS YAML modules",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -91,6 +91,9 @@
91
91
  {
92
92
  "$ref": "movement.json"
93
93
  },
94
+ {
95
+ "$ref": "notification.json"
96
+ },
94
97
  {
95
98
  "$ref": "note.json"
96
99
  },
@@ -0,0 +1,71 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Notification Tasks",
4
+ "description": "Notification entity operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "Notification/Create@1"
11
+ ],
12
+ "description": "Task type identifier"
13
+ },
14
+ "name": {
15
+ "type": "string",
16
+ "description": "Step name identifier"
17
+ },
18
+ "description": {
19
+ "type": "string",
20
+ "description": "Step description"
21
+ },
22
+ "conditions": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "object",
26
+ "properties": {
27
+ "expression": {
28
+ "type": "string"
29
+ }
30
+ },
31
+ "required": ["expression"]
32
+ }
33
+ },
34
+ "continueOnError": {
35
+ "type": "boolean"
36
+ },
37
+ "inputs": {
38
+ "type": "object",
39
+ "description": "Notification operation inputs",
40
+ "properties": {
41
+ "organizationId": {
42
+ "type": ["string", "integer"],
43
+ "description": "Organization ID (int)"
44
+ },
45
+ "notification": {
46
+ "type": "object",
47
+ "description": "Notification values to create",
48
+ "additionalProperties": true
49
+ }
50
+ },
51
+ "additionalProperties": true
52
+ },
53
+ "outputs": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "object",
57
+ "properties": {
58
+ "name": {
59
+ "type": "string"
60
+ },
61
+ "mapping": {
62
+ "type": "string"
63
+ }
64
+ },
65
+ "required": ["name", "mapping"]
66
+ }
67
+ }
68
+ },
69
+ "required": ["task"],
70
+ "additionalProperties": true
71
+ }
@@ -14,6 +14,7 @@
14
14
  - Order sub-entity tasks (OrderCommodity, OrderCharge, OrderDocument, OrderTrackingEvent, OrderEntity)
15
15
  - Inventory tasks (InventoryItem Create, Update, Delete)
16
16
  - Other entity tasks (Movement, Country, Cities, Rate, TrackingEvent/Import)
17
+ - Notification tasks (Create)
17
18
  - Note tasks (Create, Update, Delete, Import, Export, RenameThread)
18
19
  - AccountingTransaction/ApplyCredit task
19
20
 
@@ -345,6 +346,28 @@ Each event in the `events` array: `eventDefinitionName` (required), `eventDate`,
345
346
 
346
347
  Output `result`: `{ added, updated, skipped, failed, total, errors[] }`.
347
348
 
349
+ ## Notification
350
+
351
+ | Task | Description |
352
+ |------|-------------|
353
+ | `Notification/Create` | Create a notification for an organization |
354
+
355
+ ```yaml
356
+ - task: "Notification/Create@1"
357
+ name: CreateNotification
358
+ inputs:
359
+ organizationId: "{{ int inputs.organizationId }}"
360
+ notification:
361
+ message: "Order {{ inputs.orderNumber }} has been processed"
362
+ type: "Info"
363
+ outputs:
364
+ - name: notification
365
+ mapping: "notification"
366
+ ```
367
+
368
+ **Inputs:** `organizationId` (int, required), `notification` (object, required — notification values).
369
+ **Outputs:** `notification` (the created notification object).
370
+
348
371
  ## Note
349
372
 
350
373
  | Task | Description |