ulams events

Generated from front/cli (ulams schema)

`ulams events create`

Store a newly created Stationary event in storage.

Kind: write. Stability: stable. MCP tool: events_create. Scopes: events:write.

Endpoints: POST /api/admin/stationary-events.

Flag	Type	Required	Description
`--agenda`	object		agenda
`--authors`	array		authors
`--categories`	array		categories
`--description`	string	yes	description
`--finished-at`	string	yes	finished_at
`--image`	string		image (path of a local file)
`--max-participants`	integer		max_participants
`--name`	string	yes	name
`--place`	string		place
`--program`	string		program
`--short-desc`	string		short description
`--started-at`	string	yes	started_at
`--status`	string	yes	status

# Store a newly created Stationary event in storage
ulams events create --description text --finished-at text --name Example --started-at text --status text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "agenda": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "agenda"
    },
    "authors": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      },
      "description": "authors"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      },
      "description": "categories"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "finished_at": {
      "type": "string",
      "description": "finished_at"
    },
    "image": {
      "type": "string",
      "description": "image (path of a local file)"
    },
    "max_participants": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "max_participants"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "place": {
      "type": "string",
      "description": "place"
    },
    "program": {
      "type": "string",
      "description": "program"
    },
    "short_desc": {
      "type": "string",
      "description": "short description"
    },
    "started_at": {
      "type": "string",
      "description": "started_at"
    },
    "status": {
      "type": "string",
      "description": "status"
    }
  },
  "required": [
    "description",
    "finished_at",
    "name",
    "started_at",
    "status"
  ],
  "additionalProperties": {}
}

`ulams events delete`

Remove the specified Stationary Event from storage.

Kind: destructive (idempotent). Stability: stable. MCP tool: events_delete. Scopes: events:write.

Endpoints: DELETE /api/admin/stationary-events/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	id of Stationary Event

# Remove the specified Stationary Event from storage
ulams events delete 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Stationary Event"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams events get`

Display the specified Stationary Event.

Kind: read (idempotent). Stability: stable. MCP tool: events_get. Scopes: events:read.

Endpoints: GET /api/admin/stationary-events/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	id of Stationary event

# Display the specified Stationary Event
ulams events get 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Stationary event"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams events list`

Get a listing of the Stationary events.

Kind: read (idempotent). Stability: stable. MCP tool: events_list. Scopes: events:read.

Endpoints: GET /api/admin/stationary-events.

Flag	Type	Description
`--order-by`	string
`--order`	string
`--page`	number	Pagination Page Number
`--per-page`	number	Pagination Per Page
`--name`	string	Stationary event name %LIKE%
`--status`	string

# Get a listing of the Stationary events
ulams events list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "finished_at",
        "started_at",
        "created_at",
        "name"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "number",
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "number",
      "description": "Pagination Per Page"
    },
    "name": {
      "type": "string",
      "description": "Stationary event name %LIKE%"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "archived",
        "published",
        "published_unactivated"
      ]
    }
  },
  "additionalProperties": {}
}

`ulams events trigger-manually`

Manually triggered event for users.

Kind: write. Stability: stable. MCP tool: events_trigger_manually. Scopes: settings:write.

Endpoints: POST /api/admin/events/trigger-manually/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	Template id
`--users`	array		Ids of users

# Manually triggered event for users
ulams events trigger-manually 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Template id"
    },
    "users": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      },
      "description": "Ids of users"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams events update`

Update the specified Stationary Event in storage.

Kind: write (idempotent). Stability: stable. MCP tool: events_update. Scopes: events:write.

Endpoints: PUT /api/admin/stationary-events/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	id of Stationary Events
`--agenda`	object		agenda
`--authors`	array		authors
`--categories`	array		categories
`--description`	string		description
`--finished-at`	string		finished_at
`--image`	string		image (path of a local file)
`--image-path`	string		image_path
`--max-participants`	integer		max_participants
`--name`	string		name
`--place`	string		place
`--program`	string		program
`--short-desc`	string		short description
`--started-at`	string		started_at
`--status`	string		status

# Update the specified Stationary Event in storage
ulams events update 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Stationary Events"
    },
    "agenda": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "agenda"
    },
    "authors": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      },
      "description": "authors"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      },
      "description": "categories"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "finished_at": {
      "type": "string",
      "description": "finished_at"
    },
    "image": {
      "type": "string",
      "description": "image (path of a local file)"
    },
    "image_path": {
      "type": "string",
      "description": "image_path"
    },
    "max_participants": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "max_participants"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "place": {
      "type": "string",
      "description": "place"
    },
    "program": {
      "type": "string",
      "description": "program"
    },
    "short_desc": {
      "type": "string",
      "description": "short description"
    },
    "started_at": {
      "type": "string",
      "description": "started_at"
    },
    "status": {
      "type": "string",
      "description": "status"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}