Upload value model | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.valueModels.updateValueModel({
        content: {
            currency: "USD",
            valueTypes: [
                {
                    slug: "revenue",
                    name: "Revenue",
                },
            ],
            formulas: [
                {
                    id: "formula1",
                    valueTypeSlug: "revenue",
                    label: "Total Revenue Calculation",
                    variables: [
                        {
                            id: "var1",
                            label: "Base Revenue",
                        },
                    ],
                    expression: "var1 * 1.1",
                },
            ],
            signals: [
                {
                    eventName: "purchase_completed",
                    label: "Purchase Completed Event",
                },
            ],
        },
    });
}
main();

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "version": 3,
  "content": {
    "currency": "USD",
    "valueTypes": [
      {
        "slug": "revenue",
        "name": "Revenue",
        "unit": {
          "type": "monetary"
        },
        "monetaryConversion": {
          "expression": "base_amount * exchange_rate",
          "variables": [
            {
              "id": "exchange_rate",
              "label": "Exchange Rate",
              "default": 1
            }
          ],
          "conditions": [
            {
              "field": "region",
              "operator": "eq_string",
              "value": 1,
              "result": {
                "type": "constant",
                "value": 1,
                "expression": "1"
              }
            }
          ]
        },
        "description": "Total revenue in USD",
        "displayOrder": 1,
        "color": "#4CAF50",
        "icon": "dollar-sign"
      }
    ],
    "formulas": [
      {
        "id": "formula1",
        "valueTypeSlug": "revenue",
        "label": "Total Revenue Calculation",
        "variables": [
          {
            "id": "var1",
            "label": "Base Revenue",
            "type": "number",
            "description": "Initial revenue value",
            "derivedFrom": {
              "sourceField": "base_revenue",
              "targetUnit": "seconds"
            }
          }
        ],
        "expression": "var1 * 1.1",
        "description": "Calculates total revenue including adjustments",
        "conditions": [
          {
            "field": "var1",
            "operator": "gte",
            "value": 1000,
            "result": {
              "type": "constant",
              "value": 1.1,
              "expression": "1.1"
            }
          }
        ],
        "defaultResult": {
          "type": "constant",
          "value": 1,
          "expression": "1"
        }
      }
    ],
    "signals": [
      {
        "eventName": "purchase_completed",
        "label": "Purchase Completed Event",
        "formulaId": "formula1",
        "variableMapping": {},
        "defaults": {},
        "segmentTableIds": [
          "segment1"
        ],
        "description": "Signal triggered when a purchase is completed",
        "labels": [
          "purchase",
          "transaction"
        ],
        "tags": [
          "ecommerce",
          "sales"
        ]
      }
    ],
    "segmentTables": [
      {
        "id": "segment1",
        "label": "Customer Segments",
        "segmentKeys": [
          "customer_type"
        ],
        "columns": [
          {
            "variableId": "var1",
            "label": "Base Revenue",
            "type": "number"
          }
        ],
        "rows": [
          {
            "segmentValues": {},
            "variables": {}
          }
        ],
        "defaultRow": {}
      }
    ],
    "overrides": [
      {
        "id": "override1",
        "label": "VIP Customer Override",
        "scope": {
          "customerIds": [
            "cust123"
          ],
          "customerGroupIds": [
            "vip_customers"
          ]
        },
        "currency": "USD",
        "signalOverrides": {},
        "additionalSignals": [
          {
            "eventName": "vip_purchase",
            "label": "VIP Purchase Event",
            "formulaId": "formula1",
            "variableMapping": {},
            "defaults": {},
            "segmentTableIds": [
              "segment1"
            ],
            "description": "Additional signal for VIP purchases",
            "labels": [
              "vip",
              "purchase"
            ],
            "tags": [
              "vip",
              "sales"
            ]
          }
        ],
        "monetaryConversionOverrides": {}
      }
    ]
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "activatedAt": "2024-01-15T09:30:00Z",
  "effectiveFrom": "2024-01-15T09:30:00Z",
  "effectiveTo": "2025-01-15T09:30:00Z"
}

Uploads a new value model version. Validates the content, creates a new version, archives the previous active version, syncs to ClickHouse, and triggers a backfill of all historical signals.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

contentobjectRequired

Full value model configuration: value types, formulas, signals, and overrides.

effectiveFromdatetimeOptional

effectiveTodatetimeOptional

Response

200

idstringformat: "uuid"

Value model version ID.

versioninteger

Monotonically increasing version number.

contentobject

Full value model configuration: value types, formulas, signals, and overrides.

createdAtdatetime

activatedAtdatetime or null

effectiveFromdatetime or null

effectiveTodatetime or null

Errors

400

Bad Request Error

500

Internal Server Error