@reveldigital/mcp-graphql-proxy 2.0.0 → 2.2.0

package/src/types/schema.graphql

@@ -693,6 +693,37 @@ type Mutation {
   sendBulkDeviceCommands(input: BulkCommandInput): BulkCommandResult
     @cost(weight: "10")
   """
+  Create a new device group (organizational folder for player devices).
+  Mirrors the REST POST /api/devices/groups endpoint.
+  Example: An AI agent organizes newly provisioned players into a "Lobby Displays" group.
+  """
+  createDeviceGroup(input: CreateGroupInput): GroupMutationResult
+    @cost(weight: "10")
+  """
+  Create a new media group (organizational folder for uploaded content files).
+  Mirrors the REST POST /api/media/groups endpoint.
+  """
+  createMediaGroup(input: CreateGroupInput): GroupMutationResult
+    @cost(weight: "10")
+  """
+  Create a new playlist group (organizational folder for playlists).
+  Mirrors the REST POST /api/playlists/groups endpoint.
+  """
+  createPlaylistGroup(input: CreateGroupInput): GroupMutationResult
+    @cost(weight: "10")
+  """
+  Create a new schedule group (organizational folder for schedules).
+  Mirrors the REST POST /api/schedules/groups endpoint.
+  """
+  createScheduleGroup(input: CreateGroupInput): GroupMutationResult
+    @cost(weight: "10")
+  """
+  Create a new template group (organizational folder for screen layouts/templates).
+  Mirrors the REST POST /api/templates/groups endpoint.
+  """
+  createTemplateGroup(input: CreateGroupInput): GroupMutationResult
+    @cost(weight: "10")
+  """
   Create a new media asset by downloading from a URL.
   Useful for AI agents that generate images/videos and need to add them to the CMS.
   Example: AI generates a promotional image via DALL-E and uploads it for digital signage display.
@@ -748,6 +779,60 @@ type Mutation {
   """
   reorderPlaylistSources(input: ReorderPlaylistSourcesInput): PlaylistMutationResult
     @cost(weight: "10")
+  """
+  Update a template's properties (name, tags, dimensions, colors, etc.).
+  Example: AI adjusts template dimensions to optimize for a new display resolution.
+  """
+  updateTemplate(input: UpdateTemplateInput): TemplateMutationResult
+    @cost(weight: "10")
+  """
+  Add a new module to a template.
+  Example: AI adds a new weather module to show real-time conditions in the corner.
+  """
+  addTemplateModule(input: AddTemplateModuleInput): ModuleMutationResult
+    @cost(weight: "10")
+  """
+  Update a module within a template.
+  Example: AI repositions a module based on engagement analytics, or changes the assigned playlist.
+  """
+  updateTemplateModule(input: UpdateTemplateModuleInput): ModuleMutationResult
+    @cost(weight: "10")
+  """
+  Remove a module from a template.
+  Example: AI removes an underperforming ad module to optimize content flow.
+  """
+  removeTemplateModule(input: RemoveTemplateModuleInput): ModuleMutationResult
+    @cost(weight: "10")
+  """
+  Reorder modules within a template by updating their sequence/z-order.
+  Example: AI reorders modules to bring important content to the front based on viewer engagement.
+  """
+  reorderTemplateModules(input: ReorderTemplateModulesInput): TemplateMutationResult
+    @cost(weight: "10")
+  """
+  Batch update multiple modules in a template at once.
+  Example: AI repositions all modules to create a new layout optimized for viewer attention.
+  """
+  batchUpdateTemplateModules(input: BatchUpdateTemplateModulesInput): BatchModuleMutationResult
+    @cost(weight: "10")
+  """
+  Set all options for a module (replaces existing options).
+  Example: AI configures a weather module with location, units, and API key settings.
+  """
+  setModuleOptions(input: SetModuleOptionsInput): ModuleMutationResult
+    @cost(weight: "10")
+  """
+  Add or update a single module option.
+  Example: AI updates the refresh interval for a web module.
+  """
+  upsertModuleOption(input: UpsertModuleOptionInput): ModuleOptionMutationResult
+    @cost(weight: "10")
+  """
+  Remove a module option by name.
+  Example: AI removes an outdated configuration setting from a module.
+  """
+  removeModuleOption(input: RemoveModuleOptionInput): ModuleOptionMutationResult
+    @cost(weight: "10")
 }
 
 "Aggregated audience metrics for a device over a time period"
@@ -1268,6 +1353,18 @@ type BatchDeleteDataTableRowsResult {
   error: String
 }
 
+"Result from batch updating multiple modules."
+type BatchModuleMutationResult {
+  "Total number of modules attempted."
+  totalModules: Int!
+  "Number of successful updates."
+  successCount: Int!
+  "Number of failed updates."
+  failureCount: Int!
+  "Per-module results."
+  results: [ModuleMutationResult]
+}
+
 type BatchRowResultModel {
   rowId: String
   success: Boolean!
@@ -1617,6 +1714,16 @@ type Group {
   children: [Group]
 }
 
+"Result from a group mutation (e.g., creating a new group)."
+type GroupMutationResult {
+  "Whether the operation was successful."
+  success: Boolean!
+  "The newly created (or updated) group."
+  group: Group
+  "Error message if the operation failed."
+  error: String
+}
+
 "Result from an import rows mutation."
 type ImportDataTableRowsResult {
   "Whether the overall operation was successful."
@@ -1719,28 +1826,73 @@ type Media {
 }
 
 """
-Represents a module (zone/region) within a template layout.
-Modules define rectangular areas on screen where content from playlists is displayed.
+Represents a module (also called a zone or region) within a template layout.
+Modules/zones define rectangular areas on screen where content from playlists is displayed.
+The terms "module" and "zone" are used interchangeably throughout the API.
 """
 type Module {
-  "Module id"
+  "Module/zone unique identifier"
   id: String
-  "Module name"
+  "Module/zone name"
   name: String
-  "Module type"
+  "Module/zone type (e.g., 'Playlist', 'Clock', 'Weather', 'Ticker', 'Web')"
   type: String
-  "Left position"
+  "Left position in pixels from the top-left corner of the template"
   left: Int
-  "Top position"
+  "Top position in pixels from the top-left corner of the template"
   top: Int
-  "Width"
+  "Width of the module/zone in pixels"
   width: Int
-  "Height"
+  "Height of the module/zone in pixels"
   height: Int
-  "Playlist assigned to this module"
+  """
+  Playlist ID assigned to this module/zone.
+  Determines what content is displayed in this area of the screen.
+  """
   playlistId: String
-  "Sequence or Z-Order"
+  """
+  Sequence or Z-order for overlapping modules/zones.
+  Higher values appear in front of lower values.
+  """
   sequence: Int
+  """
+  Module/zone configuration options (key-value pairs).
+  Used to store type-specific settings like timezone for Clock zones, location for Weather zones, etc.
+  """
+  options: [ModuleOption]
+}
+
+"Result from a module mutation within a template."
+type ModuleMutationResult {
+  "Whether the operation was successful."
+  success: Boolean!
+  "The created or updated module."
+  module: Module
+  "Error message if the operation failed."
+  error: String
+}
+
+"""
+Represents a configuration option for a module/zone (key-value pair).
+Module/zone options store settings specific to each module/zone type.
+"""
+type ModuleOption {
+  "Module/zone option unique identifier"
+  id: String
+  "Option name/key (e.g., 'timezone', 'location', 'refresh_interval')"
+  name: String
+  "Option value (stored as string, parse as needed for the specific option)"
+  value: String
+}
+
+"Result from a module option mutation."
+type ModuleOptionMutationResult {
+  "Whether the operation was successful."
+  success: Boolean!
+  "The created or updated module option."
+  option: ModuleOption
+  "Error message if the operation failed."
+  error: String
 }
 
 """
@@ -2085,12 +2237,26 @@ type Template {
   width: Int
   "Height"
   height: Int
-  "Orientation (Landscape, Portrait, Landscape Reversed, Portrait Reversed)"
+  "Display orientation: Landscape, Portrait, Landscape Reversed, or Portrait Reversed"
   orientation: Int
-  "Modules or zones"
+  """
+  Collection of modules/zones that define content areas within this template.
+  Each module/zone represents a rectangular region where content from a playlist is displayed.
+  The terms "module" and "zone" are used interchangeably.
+  """
   modules: [Module]
 }
 
+"Result from a template mutation."
+type TemplateMutationResult {
+  "Whether the operation was successful."
+  success: Boolean!
+  "The updated template."
+  template: Template
+  "Error message if the operation failed."
+  error: String
+}
+
 "Result from updating media metadata."
 type UpdateMediaResult {
   "Whether the operation was successful."
@@ -2170,6 +2336,14 @@ input AddPlaylistSourceInput {
   position: Int
 }
 
+"Input for adding a module to a template."
+input AddTemplateModuleInput {
+  "The template ID to add the module to."
+  templateId: String
+  "The module to add."
+  module: ModuleInput
+}
+
 "Aggregated audience metrics for a device over a time period"
 input AdHawkAudienceMetricsFilterInput {
   and: [AdHawkAudienceMetricsFilterInput!]
@@ -3221,6 +3395,14 @@ input BatchDeleteDataTableRowsInput {
   rowIds: [String]
 }
 
+"Input for batch updating multiple modules in a template."
+input BatchUpdateTemplateModulesInput {
+  "The template ID."
+  templateId: String
+  "List of module updates to apply."
+  modules: [UpdateTemplateModuleInput]
+}
+
 """
 Represents Bluetooth Low Energy (BLE) beacon configuration for a device.
 Beacons enable proximity-based interactions, allowing mobile devices to detect nearby digital signage
@@ -3478,6 +3660,17 @@ input CreateDataTableRowInput {
   data: Any
 }
 
+"""
+Input for creating a new organizational group (folder) for a resource type
+(devices, media, playlists, schedules, or templates).
+"""
+input CreateGroupInput {
+  "The name of the new group."
+  name: String
+  "Optional parent group ID to nest this group under. If omitted, the group is created at the root level."
+  parentId: String
+}
+
 "Input for creating a media asset by downloading from a URL."
 input CreateMediaFromUrlInput {
   "URL to download the media file from."
@@ -3904,6 +4097,13 @@ input ListFilterInputTypeOfModuleFilterInput {
   any: Boolean @cost(weight: "10")
 }
 
+input ListFilterInputTypeOfModuleOptionFilterInput {
+  all: ModuleOptionFilterInput @cost(weight: "10")
+  none: ModuleOptionFilterInput @cost(weight: "10")
+  some: ModuleOptionFilterInput @cost(weight: "10")
+  any: Boolean @cost(weight: "10")
+}
+
 input ListFilterInputTypeOfScheduleDeviceFilterInput {
   all: ScheduleDeviceFilterInput @cost(weight: "10")
   none: ScheduleDeviceFilterInput @cost(weight: "10")
@@ -4096,30 +4296,96 @@ input MediaSortInput {
 }
 
 """
-Represents a module (zone/region) within a template layout.
-Modules define rectangular areas on screen where content from playlists is displayed.
+Represents a module (also called a zone or region) within a template layout.
+Modules/zones define rectangular areas on screen where content from playlists is displayed.
+The terms "module" and "zone" are used interchangeably throughout the API.
 """
 input ModuleFilterInput {
   and: [ModuleFilterInput!]
   or: [ModuleFilterInput!]
-  "Module id"
+  "Module/zone unique identifier"
   id: StringOperationFilterInput
-  "Module name"
+  "Module/zone name"
   name: StringOperationFilterInput
-  "Module type"
+  "Module/zone type (e.g., 'Playlist', 'Clock', 'Weather', 'Ticker', 'Web')"
   type: StringOperationFilterInput
-  "Left position"
+  "Left position in pixels from the top-left corner of the template"
   left: IntOperationFilterInput
-  "Top position"
+  "Top position in pixels from the top-left corner of the template"
   top: IntOperationFilterInput
-  "Width"
+  "Width of the module/zone in pixels"
   width: IntOperationFilterInput
-  "Height"
+  "Height of the module/zone in pixels"
   height: IntOperationFilterInput
-  "Playlist assigned to this module"
+  """
+  Playlist ID assigned to this module/zone.
+  Determines what content is displayed in this area of the screen.
+  """
   playlistId: StringOperationFilterInput
-  "Sequence or Z-Order"
+  """
+  Sequence or Z-order for overlapping modules/zones.
+  Higher values appear in front of lower values.
+  """
   sequence: IntOperationFilterInput
+  """
+  Module/zone configuration options (key-value pairs).
+  Used to store type-specific settings like timezone for Clock zones, location for Weather zones, etc.
+  """
+  options: ListFilterInputTypeOfModuleOptionFilterInput
+}
+
+"Input for a module within a template - used when adding modules."
+input ModuleInput {
+  "Module name."
+  name: String
+  "Module type (e.g., 'Playlist', 'Clock', 'Weather', 'Ticker', 'Web')."
+  type: String
+  "Left position in pixels."
+  left: Int
+  "Top position in pixels."
+  top: Int
+  "Width in pixels."
+  width: Int
+  "Height in pixels."
+  height: Int
+  "Playlist ID assigned to this module."
+  playlistId: String
+  "Z-order/sequence for overlapping modules."
+  sequence: Int
+}
+
+"""
+Represents a configuration option for a module/zone (key-value pair).
+Module/zone options store settings specific to each module/zone type.
+"""
+input ModuleOptionFilterInput {
+  and: [ModuleOptionFilterInput!]
+  or: [ModuleOptionFilterInput!]
+  "Module/zone option unique identifier"
+  id: StringOperationFilterInput
+  "Option name/key (e.g., 'timezone', 'location', 'refresh_interval')"
+  name: StringOperationFilterInput
+  "Option value (stored as string, parse as needed for the specific option)"
+  value: StringOperationFilterInput
+}
+
+"""
+Request model for creating or updating a module/zone option.
+Used to set configuration values for specific module/zone types.
+"""
+input ModuleOptionRequestInput {
+  "Option name/key (e.g., 'timezone', 'location', 'url')"
+  name: String
+  "Option value (string representation that will be parsed based on the option type)"
+  value: String
+}
+
+"Represents a module ID and its new sequence number for reordering."
+input ModuleSequenceInput {
+  "The module ID."
+  moduleId: String
+  "The new sequence/z-order value."
+  sequence: Int!
 }
 
 input NullableOfAdHawkAgeRangeOperationFilterInput {
@@ -4349,6 +4615,24 @@ input PlaylistTypeOperationFilterInput {
   nin: [PlaylistType!] @cost(weight: "10")
 }
 
+"Input for removing a module option by name."
+input RemoveModuleOptionInput {
+  "The template ID."
+  templateId: String
+  "The module ID."
+  moduleId: String
+  "The option name to remove."
+  optionName: String
+}
+
+"Input for removing a module from a template."
+input RemoveTemplateModuleInput {
+  "The template ID containing the module."
+  templateId: String
+  "The module ID to remove."
+  moduleId: String
+}
+
 "Input for reordering rows in a data table."
 input ReorderDataTableRowsInput {
   "The table ID containing the rows."
@@ -4365,6 +4649,14 @@ input ReorderPlaylistSourcesInput {
   sourceIds: [String]
 }
 
+"Input for reordering modules within a template."
+input ReorderTemplateModulesInput {
+  "The template ID."
+  templateId: String
+  "List of module IDs with their new sequence numbers."
+  moduleSequences: [ModuleSequenceInput]
+}
+
 "Input for rolling back a row to a previous version."
 input RollbackDataTableRowInput {
   "The table ID containing the row."
@@ -4595,6 +4887,16 @@ input ScheduleTypeOperationFilterInput {
   nin: [ScheduleType!] @cost(weight: "10")
 }
 
+"Input for setting all options for a module (replaces existing)."
+input SetModuleOptionsInput {
+  "The template ID."
+  templateId: String
+  "The module ID."
+  moduleId: String
+  "List of options to set (replaces all existing options)."
+  options: [ModuleOptionRequestInput]
+}
+
 """
 Represents a content item within a playlist. A source defines what content to display
 and for how long. Sources can reference media files, templates, embedded playlists, URLs, or other content types.
@@ -4712,9 +5014,13 @@ input TemplateFilterInput {
   width: IntOperationFilterInput
   "Height"
   height: IntOperationFilterInput
-  "Orientation (Landscape, Portrait, Landscape Reversed, Portrait Reversed)"
+  "Display orientation: Landscape, Portrait, Landscape Reversed, or Portrait Reversed"
   orientation: IntOperationFilterInput
-  "Modules or zones"
+  """
+  Collection of modules/zones that define content areas within this template.
+  Each module/zone represents a rectangular region where content from a playlist is displayed.
+  The terms "module" and "zone" are used interchangeably.
+  """
   modules: ListFilterInputTypeOfModuleFilterInput
 }
 
@@ -4749,7 +5055,7 @@ input TemplateSortInput {
   width: SortEnumType @cost(weight: "10")
   "Height"
   height: SortEnumType @cost(weight: "10")
-  "Orientation (Landscape, Portrait, Landscape Reversed, Portrait Reversed)"
+  "Display orientation: Landscape, Portrait, Landscape Reversed, or Portrait Reversed"
   orientation: SortEnumType @cost(weight: "10")
 }
 
@@ -4837,6 +5143,62 @@ input UpdatePlaylistSourceInput {
   source: SourceInput
 }
 
+"Input for updating a template's properties."
+input UpdateTemplateInput {
+  "The template ID to update."
+  templateId: String
+  "Template name."
+  name: String
+  "Group ID to assign the template to."
+  groupId: String
+  "Tags (newline-delimited values stored in Description field)."
+  tags: String
+  "Template script for custom logic."
+  script: String
+  "Background color (e.g., '#000000')."
+  backColor: String
+  "Template width in pixels."
+  width: Int
+  "Template height in pixels."
+  height: Int
+  "Display orientation (0=Landscape, 1=Portrait, 2=Landscape Reversed, 3=Portrait Reversed)."
+  orientation: Int
+}
+
+"Input for updating an existing module within a template."
+input UpdateTemplateModuleInput {
+  "The template ID containing the module."
+  templateId: String
+  "The module ID to update."
+  moduleId: String
+  "Module name."
+  name: String
+  "Module type."
+  type: String
+  "Left position in pixels."
+  left: Int
+  "Top position in pixels."
+  top: Int
+  "Width in pixels."
+  width: Int
+  "Height in pixels."
+  height: Int
+  "Playlist ID assigned to this module."
+  playlistId: String
+  "Z-order/sequence."
+  sequence: Int
+}
+
+"Input for upserting (create or update) a single module option."
+input UpsertModuleOptionInput {
+  "The template ID."
+  templateId: String
+  "The module ID."
+  moduleId: String
+  "The option to create or update (matched by name)."
+  option: ModuleOptionRequestInput
+}
+
 "User model"
 input UserFilterInput {
   and: [UserFilterInput!]