lexq-recipes

LexQ CLI — Recipes

Prerequisite: Read lexq-shared/SKILL.md first. Each recipe is a complete, copy-paste workflow.

Recipe 1: Tiered Discount Policy

Goal: Apply different discounts based on payment amount.

# 1. Create group
lexq groups create --json '{
  "name": "tiered-discount",
  "description": "Apply discount based on payment amount tiers"
}'
# → Save the group ID

# 2. Create DRAFT version
lexq versions create --group-id <gid> --json '{"commitMessage": "Initial tiered discount"}'
# → Save the version ID

# 3. Register facts (skip if already exist)
lexq facts create --key paymentAmount --name "Payment Amount" --type NUMBER --required
lexq facts create --key customerTier --name "Customer Tier" --type STRING \
  --allowed-values "VIP, GOLD, SILVER"
# A value domain says which values the fact accepts. It refuses a rule literal that could
# never match (a typo like "PLATNUM"), and the Console offers a dropdown instead of a text box.
# Leave it off when the set is open — a country code, an account id, a free-text label.

# 4. Add rules — creation order becomes priority order (first created = priority 1 = highest)
lexq rules create --group-id <gid> --version-id <vid> --json '{
  "name": "Premium Tier - 20%",
  "condition": {
    "type": "SINGLE",
    "field": "paymentAmount",
    "operator": "GREATER_THAN_OR_EQUAL",
    "value": 500000,
    "valueType": "NUMBER"
  },
  "actions": [{
    "type": "MUTATE_FACT",
    "parameters": {
      "targetVar": "paymentAmount",
      "method": "PERCENTAGE",
      "operator": "SUB",
      "operand": 20,
      "rounding": { "mode": "HALF_UP", "scale": 0 }
    }
  }]
}'

lexq rules create --group-id <gid> --version-id <vid> --json '{
  "name": "Gold Tier - 10%",
  "condition": {
    "type": "GROUP",
    "operator": "AND",
    "children": [
      { "type": "SINGLE", "field": "paymentAmount", "operator": "GREATER_THAN_OR_EQUAL", "value": 100000, "valueType": "NUMBER" },
      { "type": "SINGLE", "field": "paymentAmount", "operator": "LESS_THAN", "value": 500000, "valueType": "NUMBER" }
    ]
  },
  "actions": [{
    "type": "MUTATE_FACT",
    "parameters": {
      "targetVar": "paymentAmount",
      "method": "PERCENTAGE",
      "operator": "SUB",
      "operand": 10,
      "rounding": { "mode": "HALF_UP", "scale": 0 }
    }
  }]
}'

lexq rules create --group-id <gid> --version-id <vid> --json '{
  "name": "Base Tier - 5%",
  "condition": {
    "type": "SINGLE",
    "field": "paymentAmount",
    "operator": "GREATER_THAN_OR_EQUAL",
    "value": 30000,
    "valueType": "NUMBER"
  },
  "actions": [{
    "type": "MUTATE_FACT",
    "parameters": {
      "targetVar": "paymentAmount",
      "method": "PERCENTAGE",
      "operator": "SUB",
      "operand": 5,
      "rounding": { "mode": "HALF_UP", "scale": 0 }
    }
  }]
}'

# 5. Validate
lexq analytics dry-run --version-id <vid> --debug --json '{"facts":{"paymentAmount":600000}}'
# Expected: mutatedFacts.paymentAmount = 480000, generatedVariables.paymentAmount__delta = -120000

lexq analytics dry-run --version-id <vid> --debug --json '{"facts":{"paymentAmount":200000}}'
# Expected: mutatedFacts.paymentAmount = 180000, generatedVariables.paymentAmount__delta = -20000

# 6. Deploy
lexq deploy publish --group-id <gid> --version-id <vid> --memo "Tiered discount v1"
lexq deploy live --group-id <gid> --version-id <vid> --memo "Go live"