@cxtms/cx-schema 1.1.1 → 1.2.1

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.
@@ -10,7 +10,10 @@
10
10
  "Attachment/Create@1",
11
11
  "Attachment/Update@1",
12
12
  "Attachment/Delete@1",
13
- "Attachment/Get@1"
13
+ "Attachment/Get@1",
14
+ "Attachment/Thumbnail",
15
+ "Attachment/PdfThumbnail",
16
+ "Attachment/RegenerateThumbnails"
14
17
  ],
15
18
  "description": "Task type identifier"
16
19
  },
@@ -0,0 +1,72 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Authentication Tasks",
4
+ "description": "Authentication and OAuth operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "Authentication/OAuth2"
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": { "type": "string" }
28
+ },
29
+ "required": ["expression"]
30
+ }
31
+ },
32
+ "continueOnError": {
33
+ "type": "boolean"
34
+ },
35
+ "inputs": {
36
+ "type": "object",
37
+ "description": "Authentication operation inputs",
38
+ "properties": {
39
+ "provider": {
40
+ "type": "string",
41
+ "description": "OAuth2 provider name"
42
+ },
43
+ "clientId": {
44
+ "type": "string",
45
+ "description": "OAuth2 client ID"
46
+ },
47
+ "clientSecret": {
48
+ "type": "string",
49
+ "description": "OAuth2 client secret"
50
+ },
51
+ "tokenUrl": {
52
+ "type": "string",
53
+ "description": "Token endpoint URL"
54
+ }
55
+ },
56
+ "additionalProperties": true
57
+ },
58
+ "outputs": {
59
+ "type": "array",
60
+ "items": {
61
+ "type": "object",
62
+ "properties": {
63
+ "name": { "type": "string" },
64
+ "mapping": { "type": "string" }
65
+ },
66
+ "required": ["name", "mapping"]
67
+ }
68
+ }
69
+ },
70
+ "required": ["task"],
71
+ "additionalProperties": true
72
+ }
@@ -0,0 +1,68 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Caching Tasks",
4
+ "description": "In-memory cache operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "Caching/SetCache@1",
11
+ "Caching/GetCache@1"
12
+ ],
13
+ "description": "Task type identifier"
14
+ },
15
+ "name": {
16
+ "type": "string",
17
+ "description": "Step name identifier"
18
+ },
19
+ "description": {
20
+ "type": "string",
21
+ "description": "Step description"
22
+ },
23
+ "conditions": {
24
+ "type": "array",
25
+ "items": {
26
+ "type": "object",
27
+ "properties": {
28
+ "expression": { "type": "string" }
29
+ },
30
+ "required": ["expression"]
31
+ }
32
+ },
33
+ "continueOnError": {
34
+ "type": "boolean"
35
+ },
36
+ "inputs": {
37
+ "type": "object",
38
+ "description": "Caching operation inputs",
39
+ "properties": {
40
+ "key": {
41
+ "type": "string",
42
+ "description": "Cache key"
43
+ },
44
+ "value": {
45
+ "description": "Value to cache (for SetCache)"
46
+ },
47
+ "ttl": {
48
+ "type": "integer",
49
+ "description": "Time-to-live in seconds (for SetCache)"
50
+ }
51
+ },
52
+ "additionalProperties": true
53
+ },
54
+ "outputs": {
55
+ "type": "array",
56
+ "items": {
57
+ "type": "object",
58
+ "properties": {
59
+ "name": { "type": "string" },
60
+ "mapping": { "type": "string" }
61
+ },
62
+ "required": ["name", "mapping"]
63
+ }
64
+ }
65
+ },
66
+ "required": ["task"],
67
+ "additionalProperties": true
68
+ }
@@ -10,7 +10,9 @@
10
10
  "Charge/Create@1",
11
11
  "Charge/Update",
12
12
  "Charge/Delete@1",
13
- "Charge/Calculate"
13
+ "Charge/Calculate",
14
+ "Charge/DynamicUpdate",
15
+ "Discount/Update"
14
16
  ],
15
17
  "description": "Task type identifier"
16
18
  },
@@ -9,9 +9,12 @@
9
9
  "enum": [
10
10
  "Commodity/Create@1",
11
11
  "Commodity/Update@1",
12
+ "Commodity/Update@2",
12
13
  "Commodity/Delete@1",
13
14
  "Commodity/Get@1",
15
+ "Commodity/Split@1",
14
16
  "Commodity/Repack@1",
17
+ "Commodity/Unpack@1",
15
18
  "OrderCommodity/Create@1",
16
19
  "OrderCommodity/Update@1",
17
20
  "OrderCommodity/Delete@1",
@@ -0,0 +1,72 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Contact Address Tasks",
4
+ "description": "Contact address CRUD and import operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "ContactAddress/Create",
11
+ "ContactAddress/Update",
12
+ "ContactAddress/Delete",
13
+ "ContactAddress/Import"
14
+ ],
15
+ "description": "Task type identifier"
16
+ },
17
+ "name": {
18
+ "type": "string",
19
+ "description": "Step name identifier"
20
+ },
21
+ "description": {
22
+ "type": "string",
23
+ "description": "Step description"
24
+ },
25
+ "conditions": {
26
+ "type": "array",
27
+ "items": {
28
+ "type": "object",
29
+ "properties": {
30
+ "expression": { "type": "string" }
31
+ },
32
+ "required": ["expression"]
33
+ }
34
+ },
35
+ "continueOnError": {
36
+ "type": "boolean"
37
+ },
38
+ "inputs": {
39
+ "type": "object",
40
+ "description": "Contact address operation inputs",
41
+ "properties": {
42
+ "contactId": {
43
+ "type": "string",
44
+ "description": "Parent contact ID"
45
+ },
46
+ "addressId": {
47
+ "type": "string",
48
+ "description": "Address ID (for update/delete)"
49
+ },
50
+ "entity": {
51
+ "type": "object",
52
+ "description": "Address entity data",
53
+ "additionalProperties": true
54
+ }
55
+ },
56
+ "additionalProperties": true
57
+ },
58
+ "outputs": {
59
+ "type": "array",
60
+ "items": {
61
+ "type": "object",
62
+ "properties": {
63
+ "name": { "type": "string" },
64
+ "mapping": { "type": "string" }
65
+ },
66
+ "required": ["name", "mapping"]
67
+ }
68
+ }
69
+ },
70
+ "required": ["task"],
71
+ "additionalProperties": true
72
+ }
@@ -0,0 +1,72 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Contact Payment Method Tasks",
4
+ "description": "Contact payment method operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "ContactPaymentMethod/Create",
11
+ "ContactPaymentMethod/Update",
12
+ "ContactPaymentMethod/SendChargedAmount",
13
+ "ContactPaymentMethod/VerifyChargedAmount"
14
+ ],
15
+ "description": "Task type identifier"
16
+ },
17
+ "name": {
18
+ "type": "string",
19
+ "description": "Step name identifier"
20
+ },
21
+ "description": {
22
+ "type": "string",
23
+ "description": "Step description"
24
+ },
25
+ "conditions": {
26
+ "type": "array",
27
+ "items": {
28
+ "type": "object",
29
+ "properties": {
30
+ "expression": { "type": "string" }
31
+ },
32
+ "required": ["expression"]
33
+ }
34
+ },
35
+ "continueOnError": {
36
+ "type": "boolean"
37
+ },
38
+ "inputs": {
39
+ "type": "object",
40
+ "description": "Contact payment method operation inputs",
41
+ "properties": {
42
+ "contactId": {
43
+ "type": "string",
44
+ "description": "Parent contact ID"
45
+ },
46
+ "paymentMethodId": {
47
+ "type": "string",
48
+ "description": "Payment method ID"
49
+ },
50
+ "entity": {
51
+ "type": "object",
52
+ "description": "Payment method entity data",
53
+ "additionalProperties": true
54
+ }
55
+ },
56
+ "additionalProperties": true
57
+ },
58
+ "outputs": {
59
+ "type": "array",
60
+ "items": {
61
+ "type": "object",
62
+ "properties": {
63
+ "name": { "type": "string" },
64
+ "mapping": { "type": "string" }
65
+ },
66
+ "required": ["name", "mapping"]
67
+ }
68
+ }
69
+ },
70
+ "required": ["task"],
71
+ "additionalProperties": true
72
+ }
@@ -0,0 +1,65 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "EDI Tasks",
4
+ "description": "EDI and structured file parsing operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "EDI/Parse@1",
11
+ "StructuredFile/Parse"
12
+ ],
13
+ "description": "Task type identifier"
14
+ },
15
+ "name": {
16
+ "type": "string",
17
+ "description": "Step name identifier"
18
+ },
19
+ "description": {
20
+ "type": "string",
21
+ "description": "Step description"
22
+ },
23
+ "conditions": {
24
+ "type": "array",
25
+ "items": {
26
+ "type": "object",
27
+ "properties": {
28
+ "expression": { "type": "string" }
29
+ },
30
+ "required": ["expression"]
31
+ }
32
+ },
33
+ "continueOnError": {
34
+ "type": "boolean"
35
+ },
36
+ "inputs": {
37
+ "type": "object",
38
+ "description": "EDI/parsing operation inputs",
39
+ "properties": {
40
+ "content": {
41
+ "type": "string",
42
+ "description": "File content to parse"
43
+ },
44
+ "format": {
45
+ "type": "string",
46
+ "description": "EDI format (e.g., X12, EDIFACT)"
47
+ }
48
+ },
49
+ "additionalProperties": true
50
+ },
51
+ "outputs": {
52
+ "type": "array",
53
+ "items": {
54
+ "type": "object",
55
+ "properties": {
56
+ "name": { "type": "string" },
57
+ "mapping": { "type": "string" }
58
+ },
59
+ "required": ["name", "mapping"]
60
+ }
61
+ }
62
+ },
63
+ "required": ["task"],
64
+ "additionalProperties": true
65
+ }
@@ -0,0 +1,102 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "File Transfer Tasks",
4
+ "description": "SFTP/FTP file transfer operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "FileTransfer/Connect@1",
11
+ "FileTransfer/Disconnect@1",
12
+ "FileTransfer/ListFiles@1",
13
+ "FileTransfer/DownloadFile@1",
14
+ "FileTransfer/UploadFile@1",
15
+ "FileTransfer/MoveFile@1",
16
+ "FileTransfer/DeleteFile@1"
17
+ ],
18
+ "description": "Task type identifier"
19
+ },
20
+ "name": {
21
+ "type": "string",
22
+ "description": "Step name identifier"
23
+ },
24
+ "description": {
25
+ "type": "string",
26
+ "description": "Step description"
27
+ },
28
+ "conditions": {
29
+ "type": "array",
30
+ "items": {
31
+ "type": "object",
32
+ "properties": {
33
+ "expression": { "type": "string" }
34
+ },
35
+ "required": ["expression"]
36
+ }
37
+ },
38
+ "continueOnError": {
39
+ "type": "boolean"
40
+ },
41
+ "inputs": {
42
+ "type": "object",
43
+ "description": "File transfer operation inputs",
44
+ "properties": {
45
+ "connection": {
46
+ "type": "string",
47
+ "description": "Connection reference from Connect step"
48
+ },
49
+ "host": {
50
+ "type": "string",
51
+ "description": "Remote host (for Connect)"
52
+ },
53
+ "port": {
54
+ "type": ["string", "integer"],
55
+ "description": "Remote port (for Connect)"
56
+ },
57
+ "username": {
58
+ "type": "string",
59
+ "description": "Username (for Connect)"
60
+ },
61
+ "password": {
62
+ "type": "string",
63
+ "description": "Password (for Connect)"
64
+ },
65
+ "protocol": {
66
+ "type": "string",
67
+ "description": "Protocol: sftp, ftp, ftps"
68
+ },
69
+ "path": {
70
+ "type": "string",
71
+ "description": "Remote file/directory path"
72
+ },
73
+ "sourcePath": {
74
+ "type": "string",
75
+ "description": "Source path (for MoveFile)"
76
+ },
77
+ "destinationPath": {
78
+ "type": "string",
79
+ "description": "Destination path (for MoveFile)"
80
+ },
81
+ "content": {
82
+ "type": "string",
83
+ "description": "File content (for UploadFile)"
84
+ }
85
+ },
86
+ "additionalProperties": true
87
+ },
88
+ "outputs": {
89
+ "type": "array",
90
+ "items": {
91
+ "type": "object",
92
+ "properties": {
93
+ "name": { "type": "string" },
94
+ "mapping": { "type": "string" }
95
+ },
96
+ "required": ["name", "mapping"]
97
+ }
98
+ }
99
+ },
100
+ "required": ["task"],
101
+ "additionalProperties": true
102
+ }
@@ -0,0 +1,68 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Flow Transition Task",
4
+ "description": "Trigger a Flow state transition programmatically",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "Flow/Transition@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": { "type": "string" }
28
+ },
29
+ "required": ["expression"]
30
+ }
31
+ },
32
+ "continueOnError": {
33
+ "type": "boolean"
34
+ },
35
+ "inputs": {
36
+ "type": "object",
37
+ "description": "Flow transition inputs",
38
+ "properties": {
39
+ "entityName": {
40
+ "type": "string",
41
+ "description": "Entity type name"
42
+ },
43
+ "entityId": {
44
+ "type": "string",
45
+ "description": "Entity ID"
46
+ },
47
+ "transition": {
48
+ "type": "string",
49
+ "description": "Transition name to trigger"
50
+ }
51
+ },
52
+ "additionalProperties": true
53
+ },
54
+ "outputs": {
55
+ "type": "array",
56
+ "items": {
57
+ "type": "object",
58
+ "properties": {
59
+ "name": { "type": "string" },
60
+ "mapping": { "type": "string" }
61
+ },
62
+ "required": ["name", "mapping"]
63
+ }
64
+ }
65
+ },
66
+ "required": ["task"],
67
+ "additionalProperties": true
68
+ }
@@ -82,6 +82,29 @@
82
82
  },
83
83
  "description": "Retry configuration"
84
84
  },
85
+ "responseContentType": {
86
+ "type": "string",
87
+ "description": "Expected response content type (e.g., application/pdf, application/json)"
88
+ },
89
+ "actionEvents": {
90
+ "type": "object",
91
+ "description": "Enable action events when the request operates on a specific entity",
92
+ "properties": {
93
+ "enabled": {
94
+ "type": "boolean",
95
+ "description": "Enable action event tracking"
96
+ },
97
+ "eventName": {
98
+ "type": "string",
99
+ "description": "Event name identifier (e.g., carrier.sendParcelInfo)"
100
+ },
101
+ "eventDataExt": {
102
+ "type": "object",
103
+ "description": "Extended event data linking to entity (e.g., orderId)",
104
+ "additionalProperties": true
105
+ }
106
+ }
107
+ },
85
108
  "cache": {
86
109
  "type": "object",
87
110
  "properties": {
@@ -0,0 +1,64 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Import Tasks",
4
+ "description": "Data import operations",
5
+ "type": "object",
6
+ "properties": {
7
+ "task": {
8
+ "type": "string",
9
+ "enum": [
10
+ "Utilities/Import@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": { "type": "string" }
28
+ },
29
+ "required": ["expression"]
30
+ }
31
+ },
32
+ "continueOnError": {
33
+ "type": "boolean"
34
+ },
35
+ "inputs": {
36
+ "type": "object",
37
+ "description": "Import operation inputs",
38
+ "properties": {
39
+ "content": {
40
+ "type": "string",
41
+ "description": "File content to import"
42
+ },
43
+ "format": {
44
+ "type": "string",
45
+ "description": "Import format (e.g., csv)"
46
+ }
47
+ },
48
+ "additionalProperties": true
49
+ },
50
+ "outputs": {
51
+ "type": "array",
52
+ "items": {
53
+ "type": "object",
54
+ "properties": {
55
+ "name": { "type": "string" },
56
+ "mapping": { "type": "string" }
57
+ },
58
+ "required": ["name", "mapping"]
59
+ }
60
+ }
61
+ },
62
+ "required": ["task"],
63
+ "additionalProperties": true
64
+ }