cxtms 1.9.13

package/schemas/workflows/tasks/tracking-event.json

@@ -0,0 +1,137 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "TrackingEvent Tasks",
+  "description": "Tracking event import operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "TrackingEvent/Import@1"
+      ],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "TrackingEvent/Import inputs",
+      "properties": {
+        "orderId": {
+          "type": "string",
+          "description": "Target order ID (required)"
+        },
+        "events": {
+          "type": ["array", "string"],
+          "description": "Array of tracking event objects to import. Each event: eventDefinitionName, eventDate, description, location, includeInTracking, sendEmail, isInactive, customValues",
+          "items": {
+            "type": "object",
+            "properties": {
+              "eventDefinitionName": {
+                "type": "string",
+                "description": "Name of the event definition to match or create"
+              },
+              "eventDate": {
+                "type": "string",
+                "description": "Event date (converted to UTC)"
+              },
+              "description": {
+                "type": "string",
+                "description": "Event description (overrides EventDefinition default)"
+              },
+              "location": {
+                "type": "string",
+                "description": "Event location (overrides EventDefinition default)"
+              },
+              "includeInTracking": {
+                "type": ["boolean", "string"],
+                "description": "Include in tracking display"
+              },
+              "sendEmail": {
+                "type": ["boolean", "string"],
+                "description": "Send email notification"
+              },
+              "isInactive": {
+                "type": ["boolean", "string"],
+                "description": "Mark event as inactive"
+              },
+              "customValues": {
+                "type": "object",
+                "description": "Free-form custom values (carrierId, carrierEventCode, etc.)",
+                "additionalProperties": true
+              }
+            },
+            "additionalProperties": true
+          }
+        },
+        "matchByFields": {
+          "type": "array",
+          "description": "Fields used to detect duplicate events. Supports dot notation for customValues (e.g., customValues.eventType). Default: [eventDefinitionName, eventDate]",
+          "items": {
+            "type": "string"
+          }
+        },
+        "skipIfExists": {
+          "type": ["boolean", "string"],
+          "description": "Skip event if duplicate found via matchByFields. Default: true"
+        },
+        "createEventDefinitions": {
+          "type": ["boolean", "string"],
+          "description": "Auto-create EventDefinition if name not found. Default: true"
+        },
+        "eventDefinitionDefaults": {
+          "type": "object",
+          "description": "Default values when creating new EventDefinitions (includeInTracking, sendEmail, eventName, etc.)",
+          "additionalProperties": true
+        },
+        "matchByEventDefinition": {
+          "type": "array",
+          "description": "Match EventDefinition by customValues fields instead of name (e.g., [customValues.carrierId, customValues.carrierEventCode])",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "description": "Output mapping. Result contains: added, updated, skipped, failed, total, errors",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/transmission.json

@@ -0,0 +1,185 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Transmission Tasks",
+  "description": "Create, update, and delete transmission records linked to orders",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Transmission/Create@1",
+        "Transmission/Update@1",
+        "Transmission/Delete@1"
+      ],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Task inputs — shape depends on task type",
+      "properties": {
+        "organizationId": {
+          "type": ["string", "integer"],
+          "description": "Organization ID (required for all task types)"
+        },
+        "transmissionId": {
+          "type": ["string", "integer"],
+          "description": "Transmission ID (required for Update and Delete)"
+        },
+        "transmission": {
+          "type": "object",
+          "description": "Transmission field values (Create: full object; Update: partial/dynamic)",
+          "properties": {
+            "orderIds": {
+              "type": ["array", "string"],
+              "items": { "type": ["integer", "string"] },
+              "description": "Order IDs to link (required for Create, at least one)"
+            },
+            "channel": {
+              "type": "string",
+              "maxLength": 20,
+              "description": "Communication channel (e.g. EDI, API, EMAIL, WEBHOOK)"
+            },
+            "direction": {
+              "type": ["string", "integer"],
+              "enum": ["Inbound", "Outbound", 0, 1],
+              "description": "Inbound (0) or Outbound (1)"
+            },
+            "messageType": {
+              "type": "string",
+              "maxLength": 50,
+              "description": "Message type identifier (e.g. 204, 990, 214)"
+            },
+            "sender": {
+              "type": "string",
+              "maxLength": 100,
+              "description": "Sender identifier"
+            },
+            "receiver": {
+              "type": "string",
+              "maxLength": 100,
+              "description": "Receiver identifier"
+            },
+            "correlationId": {
+              "type": "string",
+              "format": "uuid",
+              "description": "Correlation ID (auto-generated if omitted on Create)"
+            },
+            "parentId": {
+              "type": ["integer", "string", "null"],
+              "description": "Parent transmission ID for chaining"
+            },
+            "status": {
+              "type": ["string", "integer"],
+              "enum": ["Pending", "InProgress", "Sent", "Received", "Delivered", "Acknowledged", "Rejected", "Error", "RetryScheduled", "Cancelled", "Expired", "Accepted", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11],
+              "description": "Transmission status"
+            },
+            "endpoint": {
+              "type": "string",
+              "maxLength": 500,
+              "description": "Target endpoint URL"
+            },
+            "protocol": {
+              "type": "string",
+              "maxLength": 20,
+              "description": "Protocol (e.g. HTTPS, SFTP, AS2)"
+            },
+            "httpStatus": {
+              "type": ["integer", "string", "null"],
+              "description": "HTTP response status code"
+            },
+            "byteSize": {
+              "type": ["integer", "string", "null"],
+              "description": "Payload size in bytes"
+            },
+            "retryCount": {
+              "type": ["integer", "string"],
+              "description": "Current retry count (default: 0)"
+            },
+            "maxRetries": {
+              "type": ["integer", "string"],
+              "description": "Maximum retry attempts (default: 3)"
+            },
+            "nextRetryAt": {
+              "type": ["string", "null"],
+              "description": "Scheduled next retry time (ISO 8601)"
+            },
+            "errorCode": {
+              "type": ["string", "null"],
+              "maxLength": 50,
+              "description": "Error code"
+            },
+            "errorMessage": {
+              "type": ["string", "null"],
+              "description": "Error description"
+            },
+            "customValues": {
+              "type": ["object", "string", "null"],
+              "description": "Arbitrary key-value metadata (JSONB)"
+            },
+            "headers": {
+              "type": ["object", "string", "null"],
+              "description": "Message headers (JSONB)"
+            },
+            "payloadRef": {
+              "type": ["string", "null"],
+              "description": "Reference to stored payload (e.g. blob URI)"
+            },
+            "scheduledAt": {
+              "type": ["string", "null"],
+              "description": "Scheduled send time (ISO 8601)"
+            },
+            "startedAt": {
+              "type": ["string", "null"],
+              "description": "Processing start time (ISO 8601)"
+            },
+            "completedAt": {
+              "type": ["string", "null"],
+              "description": "Processing end time (ISO 8601)"
+            },
+            "durationMs": {
+              "type": ["integer", "string", "null"],
+              "description": "Processing duration in milliseconds"
+            }
+          }
+        }
+      },
+      "required": ["organizationId"]
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Create outputs: transmission (TransmissionDto). Delete outputs: success (boolean)."
+    }
+  },
+  "required": ["task", "name", "inputs"]
+}

package/schemas/workflows/tasks/unzip-file.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "UnzipFile Task",
+  "description": "Extract files from a ZIP archive (local path or URL)",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/UnzipFile@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "UnzipFile inputs — provide either filePath or fileUrl",
+      "properties": {
+        "filePath": {
+          "type": "string",
+          "description": "Local file path to ZIP archive (from saveToFile or previous step)"
+        },
+        "fileUrl": {
+          "type": "string",
+          "description": "URL to ZIP archive (file://, http://, https://)"
+        },
+        "filePattern": {
+          "type": "string",
+          "description": "Glob-style pattern to filter extracted files (e.g. '*.csv', 'data_*.json'). If omitted, all files returned."
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Outputs: Files (string[] — full paths to extracted files), Count (int — number of matched files)"
+    }
+  },
+  "required": ["task", "name", "inputs"]
+}

package/schemas/workflows/tasks/user.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "User Tasks",
+  "description": "User account management operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "User/Create",
+        "User/Update",
+        "User/Delete",
+        "User/GetVerificationCode",
+        "User/GetEmailVerificationCode",
+        "User/GetResetPasswordToken"
+      ],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": { "type": "string" }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "User operation inputs",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "User ID"
+        },
+        "entity": {
+          "type": "object",
+          "description": "User entity data",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/validation.json

@@ -0,0 +1,99 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Validation Task",
+  "description": "Validate data with rules",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Validation/Validate@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      },
+      "description": "Conditions for execution"
+    },
+    "continueOnError": {
+      "type": "boolean",
+      "description": "Continue on error"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Validation inputs",
+      "properties": {
+        "rules": {
+          "type": "array",
+          "description": "Validation rules",
+          "items": {
+            "type": "object",
+            "properties": {
+              "rule": {
+                "type": "string",
+                "enum": ["required"],
+                "description": "Rule type. Use 'required' to check a value is not null or empty"
+              },
+              "value": {
+                "description": "Value to validate (used with rule: required). Typically a template expression e.g. {{ fieldName }}",
+                "oneOf": [
+                  { "type": "string" },
+                  { "type": "number" },
+                  { "type": "boolean" },
+                  { "type": "object" },
+                  { "type": "null" }
+                ]
+              },
+              "conditions": {
+                "type": "string",
+                "description": "NCalc expression evaluated against task variables. Fails when expression is false. Variables use bracket syntax e.g. [orderId] > 0"
+              },
+              "message": {
+                "type": "string",
+                "description": "Custom error message returned when validation fails"
+              }
+            },
+            "anyOf": [
+              { "required": ["rule"] },
+              { "required": ["conditions"] }
+            ]
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Output mappings"
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/while.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "While Task",
+  "description": "Loop while conditions are true",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "const": "while",
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      },
+      "description": "Conditions to continue looping"
+    },
+    "continueOnError": {
+      "type": "boolean",
+      "description": "Continue on error"
+    },
+    "maxIterations": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Maximum number of iterations to prevent infinite loops"
+    },
+    "steps": {
+      "type": "array",
+      "description": "Steps to execute each iteration",
+      "items": {
+        "$ref": "generic.json"
+      },
+      "minItems": 1
+    }
+  },
+  "required": ["task", "conditions", "steps"],
+  "additionalProperties": true
+}