nominal-api 0.1048.1__py3-none-any.whl → 0.1056.0__py3-none-any.whl

nominal_api/nominal-api.conjure.json

@@ -841,6 +841,15 @@
     "code" : "INTERNAL",
     "safeArgs" : [ ],
     "unsafeArgs" : [ ]
+  }, {
+    "errorName" : {
+      "name" : "FailedToDownloadFileUserError",
+      "package" : "io.nominal.ingest.api"
+    },
+    "namespace" : "IngestService",
+    "code" : "INVALID_ARGUMENT",
+    "safeArgs" : [ ],
+    "unsafeArgs" : [ ]
   }, {
     "errorName" : {
       "name" : "FrameCountTimestampsMismatch",
@@ -1559,6 +1568,25 @@
       }
     } ],
     "unsafeArgs" : [ ]
+  }, {
+    "errorName" : {
+      "name" : "UnavailableResultConfiguration",
+      "package" : "io.nominal.persistent.compute.api"
+    },
+    "docs" : "ResultConfiguration is incompatible with the requested compute.",
+    "namespace" : "PersistentCompute",
+    "code" : "INVALID_ARGUMENT",
+    "safeArgs" : [ {
+      "fieldName" : "reason",
+      "type" : {
+        "type" : "reference",
+        "reference" : {
+          "name" : "UnavailableResultConfigurationReason",
+          "package" : "io.nominal.persistent.compute.api"
+        }
+      }
+    } ],
+    "unsafeArgs" : [ ]
   }, {
     "errorName" : {
       "name" : "UnsupportedGranularity",
@@ -3508,7 +3536,7 @@
     },
     "docs" : "An unexpected timeout occurred when executing a query. This indicates an internal error\nwhere the query may have succeeded but the response did not reach the client.\n",
     "namespace" : "Compute",
-    "code" : "TIMEOUT",
+    "code" : "INVALID_ARGUMENT",
     "safeArgs" : [ {
       "fieldName" : "queryId",
       "type" : {
@@ -5436,6 +5464,22 @@
       }
     } ],
     "unsafeArgs" : [ ]
+  }, {
+    "errorName" : {
+      "name" : "InvalidChannelSpecification",
+      "package" : "io.nominal.scout.video.api"
+    },
+    "docs" : "Invalid channel specification (e.g., mutually exclusive parameters provided)",
+    "namespace" : "Video",
+    "code" : "INVALID_ARGUMENT",
+    "safeArgs" : [ {
+      "fieldName" : "message",
+      "type" : {
+        "type" : "primitive",
+        "primitive" : "STRING"
+      }
+    } ],
+    "unsafeArgs" : [ ]
   }, {
     "errorName" : {
       "name" : "InvalidFileShiftScaleRequest",
@@ -5490,6 +5534,88 @@
       }
     } ],
     "unsafeArgs" : [ ]
+  }, {
+    "errorName" : {
+      "name" : "InvalidTags",
+      "package" : "io.nominal.scout.video.api"
+    },
+    "docs" : "The provided tags parameter is not valid JSON",
+    "namespace" : "Video",
+    "code" : "INVALID_ARGUMENT",
+    "safeArgs" : [ ],
+    "unsafeArgs" : [ {
+      "fieldName" : "tags",
+      "type" : {
+        "type" : "primitive",
+        "primitive" : "STRING"
+      }
+    } ]
+  }, {
+    "errorName" : {
+      "name" : "InvalidTimestamp",
+      "package" : "io.nominal.scout.video.api"
+    },
+    "docs" : "The provided timestamp string is not in valid ISO-8601 format",
+    "namespace" : "Video",
+    "code" : "INVALID_ARGUMENT",
+    "safeArgs" : [ {
+      "fieldName" : "timestamp",
+      "type" : {
+        "type" : "primitive",
+        "primitive" : "STRING"
+      }
+    } ],
+    "unsafeArgs" : [ ]
+  }, {
+    "errorName" : {
+      "name" : "MissingTimestampBoundPair",
+      "package" : "io.nominal.scout.video.api"
+    },
+    "docs" : "Both start and end timestamp bounds must be provided together, or neither. Either provide both bounds or neither.",
+    "namespace" : "Video",
+    "code" : "INVALID_ARGUMENT",
+    "safeArgs" : [ {
+      "fieldName" : "hasStart",
+      "type" : {
+        "type" : "primitive",
+        "primitive" : "BOOLEAN"
+      }
+    }, {
+      "fieldName" : "hasEnd",
+      "type" : {
+        "type" : "primitive",
+        "primitive" : "BOOLEAN"
+      }
+    } ],
+    "unsafeArgs" : [ ]
+  }, {
+    "errorName" : {
+      "name" : "NoSegmentsInBounds",
+      "package" : "io.nominal.scout.video.api"
+    },
+    "docs" : "The requested time bounds do not overlap with any video segments.",
+    "namespace" : "Video",
+    "code" : "NOT_FOUND",
+    "safeArgs" : [ {
+      "fieldName" : "videoRid",
+      "type" : {
+        "type" : "reference",
+        "reference" : {
+          "name" : "VideoRid",
+          "package" : "io.nominal.api.rids"
+        }
+      }
+    }, {
+      "fieldName" : "requestedBounds",
+      "type" : {
+        "type" : "reference",
+        "reference" : {
+          "name" : "Bounds",
+          "package" : "io.nominal.scout.video.api"
+        }
+      }
+    } ],
+    "unsafeArgs" : [ ]
   }, {
     "errorName" : {
       "name" : "NotAuthorized",
@@ -5613,8 +5739,9 @@
       "name" : "VideoIngestNotComplete",
       "package" : "io.nominal.scout.video.api"
     },
+    "docs" : "Video has no segments available. The video may still be processing or ingest has not started.",
     "namespace" : "Video",
-    "code" : "INVALID_ARGUMENT",
+    "code" : "FAILED_PRECONDITION",
     "safeArgs" : [ {
       "fieldName" : "videoRid",
       "type" : {
@@ -6319,6 +6446,24 @@
         "value" : "VIDEO"
       } ]
     }
+  }, {
+    "type" : "object",
+    "object" : {
+      "typeName" : {
+        "name" : "Deleted",
+        "package" : "io.nominal.api"
+      },
+      "fields" : [ ]
+    }
+  }, {
+    "type" : "object",
+    "object" : {
+      "typeName" : {
+        "name" : "DeletionInProgress",
+        "package" : "io.nominal.api"
+      },
+      "fields" : [ ]
+    }
   }, {
     "type" : "object",
     "object" : {
@@ -6454,6 +6599,24 @@
             "package" : "io.nominal.api"
           }
         }
+      }, {
+        "fieldName" : "deletionInProgress",
+        "type" : {
+          "type" : "reference",
+          "reference" : {
+            "name" : "DeletionInProgress",
+            "package" : "io.nominal.api"
+          }
+        }
+      }, {
+        "fieldName" : "deleted",
+        "type" : {
+          "type" : "reference",
+          "reference" : {
+            "name" : "Deleted",
+            "package" : "io.nominal.api"
+          }
+        }
       } ]
     }
   }, {
@@ -7578,6 +7741,49 @@
         "value" : "NONE"
       } ]
     }
+  }, {
+    "type" : "object",
+    "object" : {
+      "typeName" : {
+        "name" : "CoachmarkDismissal",
+        "package" : "io.nominal.authentication.api"
+      },
+      "fields" : [ {
+        "fieldName" : "coachmarkId",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "docs" : "The coachmark identifier (typically the feature flag name)"
+      }, {
+        "fieldName" : "dismissedAt",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "DATETIME"
+        },
+        "docs" : "ISO 8601 timestamp of when the coachmark was dismissed"
+      }, {
+        "fieldName" : "appVersion",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "docs" : "The apps-scout version (semver) when the coachmark was dismissed"
+      }, {
+        "fieldName" : "stepIndex",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "primitive",
+              "primitive" : "INTEGER"
+            }
+          }
+        },
+        "docs" : "The step index when dismissed (for multi-step coachmarks).\nIf not present, the coachmark was dismissed via the X button.\n"
+      } ],
+      "docs" : "A record of a coachmark dismissal, including when it was dismissed\nand on which app version.\n"
+    }
   }, {
     "type" : "enum",
     "enum" : {
@@ -7593,6 +7799,42 @@
         "value" : "RELATIVE"
       } ]
     }
+  }, {
+    "type" : "object",
+    "object" : {
+      "typeName" : {
+        "name" : "DismissCoachmarkRequest",
+        "package" : "io.nominal.authentication.api"
+      },
+      "fields" : [ {
+        "fieldName" : "coachmarkId",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "docs" : "The coachmark identifier to dismiss"
+      }, {
+        "fieldName" : "appVersion",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "docs" : "The apps-scout version (semver) when dismissing"
+      }, {
+        "fieldName" : "stepIndex",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "primitive",
+              "primitive" : "INTEGER"
+            }
+          }
+        },
+        "docs" : "The step index when dismissed (for multi-step coachmarks)"
+      } ],
+      "docs" : "Request to dismiss a coachmark"
+    }
   }, {
     "type" : "object",
     "object" : {
@@ -7635,6 +7877,62 @@
       } ],
       "docs" : "Response containing the generated MediaMTX token"
     }
+  }, {
+    "type" : "object",
+    "object" : {
+      "typeName" : {
+        "name" : "GetCoachmarkDismissalsRequest",
+        "package" : "io.nominal.authentication.api"
+      },
+      "fields" : [ {
+        "fieldName" : "coachmarkIds",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "list",
+              "list" : {
+                "itemType" : {
+                  "type" : "primitive",
+                  "primitive" : "STRING"
+                }
+              }
+            }
+          }
+        },
+        "docs" : "Optional list of coachmark IDs to filter by.\nIf empty, returns all dismissals for the user.\n"
+      } ],
+      "docs" : "Request to get coachmark dismissals"
+    }
+  }, {
+    "type" : "object",
+    "object" : {
+      "typeName" : {
+        "name" : "GetCoachmarkDismissalsResponse",
+        "package" : "io.nominal.authentication.api"
+      },
+      "fields" : [ {
+        "fieldName" : "dismissals",
+        "type" : {
+          "type" : "map",
+          "map" : {
+            "keyType" : {
+              "type" : "primitive",
+              "primitive" : "STRING"
+            },
+            "valueType" : {
+              "type" : "reference",
+              "reference" : {
+                "name" : "CoachmarkDismissal",
+                "package" : "io.nominal.authentication.api"
+              }
+            }
+          }
+        },
+        "docs" : "Map of coachmark ID to dismissal record"
+      } ],
+      "docs" : "Response containing coachmark dismissals"
+    }
   }, {
     "type" : "object",
     "object" : {
@@ -20016,6 +20314,23 @@
       },
       "docs" : "Unique resource identifier for a Module.\n"
     }
+  }, {
+    "type" : "object",
+    "object" : {
+      "typeName" : {
+        "name" : "AppendOnlyConfig",
+        "package" : "io.nominal.persistent.compute.api"
+      },
+      "fields" : [ {
+        "fieldName" : "decimateResults",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "BOOLEAN"
+        },
+        "docs" : "Specifies whether the returned results should be decimated.\nIf this is false, the client may receive a `SubscriptionCreationError` if the data rate is too high\nand responses must be decimated.\n"
+      } ],
+      "docs" : "Defines the append results from the websocket.\n"
+    }
   }, {
     "type" : "object",
     "object" : {
@@ -20534,6 +20849,24 @@
         }
       } ]
     }
+  }, {
+    "type" : "union",
+    "union" : {
+      "typeName" : {
+        "name" : "ResultConfiguration",
+        "package" : "io.nominal.persistent.compute.api"
+      },
+      "union" : [ {
+        "fieldName" : "appendOnly",
+        "type" : {
+          "type" : "reference",
+          "reference" : {
+            "name" : "AppendOnlyConfig",
+            "package" : "io.nominal.persistent.compute.api"
+          }
+        }
+      } ]
+    }
   }, {
     "type" : "union",
     "union" : {
@@ -20777,7 +21110,23 @@
             }
           }
         },
-        "docs" : "Can be set to `false` by the client to indicate that it doesn't support appends for this subscription\nand always wants to receive full results. Defaults to `false` if not set.\nThe expectation is that clients should implement support for appends for any of the results covered in\n`ComputeNodeAppendResponse` and set this to `true` as quickly as possible. However, in order to support \nadding new sub-types to `ComputeNodeAppendResponse` without breaking clients that haven't upgraded yet \nand haven't yet added support for them, we default this to `false` and make clients opt-in as soon as they\nimplement support.\n"
+        "docs" : "Can be set to `false` by the client to indicate that it doesn't support appends for this subscription\nand always wants to receive full results. Defaults to `false` if not set.\nThe expectation is that clients should implement support for appends for any of the results covered in\n`ComputeNodeAppendResponse` and set this to `true` as quickly as possible. However, in order to support \nadding new sub-types to `ComputeNodeAppendResponse` without breaking clients that haven't upgraded yet \nand haven't yet added support for them, we default this to `false` and make clients opt-in as soon as they\nimplement support.\n",
+        "deprecated" : "Use `resultConfiguration` instead.\n"
+      }, {
+        "fieldName" : "resultConfiguration",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "reference",
+              "reference" : {
+                "name" : "ResultConfiguration",
+                "package" : "io.nominal.persistent.compute.api"
+              }
+            }
+          }
+        },
+        "docs" : "Defines the results that are sent for this subscription. If not set, falls back to the behavior \ndefined by `allowAppends`.\n"
       } ]
     }
   }, {
@@ -20863,6 +21212,19 @@
         }
       } ]
     }
+  }, {
+    "type" : "enum",
+    "enum" : {
+      "typeName" : {
+        "name" : "UnavailableResultConfigurationReason",
+        "package" : "io.nominal.persistent.compute.api"
+      },
+      "values" : [ {
+        "value" : "APPENDS_NOT_SUPPORTED_FOR_COMPUTE"
+      }, {
+        "value" : "TOO_MANY_POINTS_FOR_UNDECIMATED_APPENDS"
+      } ]
+    }
   }, {
     "type" : "object",
     "object" : {
@@ -23069,6 +23431,21 @@
             }
           }
         }
+      }, {
+        "fieldName" : "metadata",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "reference",
+              "reference" : {
+                "name" : "DatasetFileMetadata",
+                "package" : "io.nominal.scout.catalog"
+              }
+            }
+          }
+        },
+        "docs" : "File-type-specific metadata. For video files, contains timestamp manifest.\n"
       } ]
     }
   }, {
@@ -24357,6 +24734,10 @@
         "value" : "COMPLETED"
       }, {
         "value" : "FAILED"
+      }, {
+        "value" : "DELETION_IN_PROGRESS"
+      }, {
+        "value" : "DELETED"
       } ]
     }
   }, {
@@ -80442,6 +80823,126 @@
       "docs" : "Generates a JWT token for MediaMTX authentication with a 2-hour expiration.\nThe token is signed with the MediaMTX private key and contains the specified permissions.\nRequires authentication with Nominal. This endpoint is intended for internal use only.\n",
       "markers" : [ ],
       "tags" : [ ]
+    }, {
+      "endpointName" : "getMyCoachmarkDismissals",
+      "httpMethod" : "POST",
+      "httpPath" : "/authentication/v2/my/coachmarks/dismissals",
+      "auth" : {
+        "type" : "header",
+        "header" : { }
+      },
+      "args" : [ {
+        "argName" : "request",
+        "type" : {
+          "type" : "reference",
+          "reference" : {
+            "name" : "GetCoachmarkDismissalsRequest",
+            "package" : "io.nominal.authentication.api"
+          }
+        },
+        "paramType" : {
+          "type" : "body",
+          "body" : { }
+        },
+        "markers" : [ ],
+        "tags" : [ ]
+      } ],
+      "returns" : {
+        "type" : "reference",
+        "reference" : {
+          "name" : "GetCoachmarkDismissalsResponse",
+          "package" : "io.nominal.authentication.api"
+        }
+      },
+      "docs" : "Gets coachmark dismissals for the authenticated user.\nOptionally filter by specific coachmark IDs.\n",
+      "markers" : [ ],
+      "tags" : [ ]
+    }, {
+      "endpointName" : "dismissMyCoachmark",
+      "httpMethod" : "POST",
+      "httpPath" : "/authentication/v2/my/coachmarks/dismiss",
+      "auth" : {
+        "type" : "header",
+        "header" : { }
+      },
+      "args" : [ {
+        "argName" : "request",
+        "type" : {
+          "type" : "reference",
+          "reference" : {
+            "name" : "DismissCoachmarkRequest",
+            "package" : "io.nominal.authentication.api"
+          }
+        },
+        "paramType" : {
+          "type" : "body",
+          "body" : { }
+        },
+        "markers" : [ ],
+        "tags" : [ ]
+      } ],
+      "returns" : {
+        "type" : "reference",
+        "reference" : {
+          "name" : "CoachmarkDismissal",
+          "package" : "io.nominal.authentication.api"
+        }
+      },
+      "docs" : "Dismisses a coachmark for the authenticated user.\nRecords the dismissal timestamp and app version.\n",
+      "markers" : [ ],
+      "tags" : [ ]
+    }, {
+      "endpointName" : "isMyCoachmarkDismissed",
+      "httpMethod" : "GET",
+      "httpPath" : "/authentication/v2/my/coachmarks/dismissed/{coachmarkId}",
+      "auth" : {
+        "type" : "header",
+        "header" : { }
+      },
+      "args" : [ {
+        "argName" : "coachmarkId",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "paramType" : {
+          "type" : "path",
+          "path" : { }
+        },
+        "markers" : [ ],
+        "tags" : [ ]
+      } ],
+      "returns" : {
+        "type" : "primitive",
+        "primitive" : "BOOLEAN"
+      },
+      "docs" : "Checks if a specific coachmark has been dismissed by the authenticated user.\n",
+      "markers" : [ ],
+      "tags" : [ ]
+    }, {
+      "endpointName" : "resetMyCoachmarkDismissal",
+      "httpMethod" : "DELETE",
+      "httpPath" : "/authentication/v2/my/coachmarks/dismissals/{coachmarkId}",
+      "auth" : {
+        "type" : "header",
+        "header" : { }
+      },
+      "args" : [ {
+        "argName" : "coachmarkId",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "paramType" : {
+          "type" : "path",
+          "path" : { }
+        },
+        "markers" : [ ],
+        "tags" : [ ]
+      } ],
+      "docs" : "Resets a coachmark dismissal for the authenticated user.\nThis allows the coachmark to be shown again.\nPrimarily intended for testing and debugging.\n",
+      "markers" : [ ],
+      "tags" : [ ]
     } ],
     "docs" : "This service provides operations for managing user and org profiles/settings.\nIts name is a bit of a misnomer.\n"
   }, {
@@ -93050,13 +93551,52 @@
         },
         "markers" : [ ],
         "tags" : [ ]
+      }, {
+        "argName" : "start",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "primitive",
+              "primitive" : "STRING"
+            }
+          }
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "start"
+          }
+        },
+        "docs" : "Start bound as ISO-8601 timestamp (e.g., \"2024-01-01T00:00:00Z\"). Must be provided together with end, or neither.",
+        "markers" : [ ],
+        "tags" : [ ]
+      }, {
+        "argName" : "end",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "primitive",
+              "primitive" : "STRING"
+            }
+          }
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "end"
+          }
+        },
+        "docs" : "End bound as ISO-8601 timestamp (e.g., \"2024-01-01T01:00:00Z\"). Must be provided together with start, or neither.",
+        "markers" : [ ],
+        "tags" : [ ]
       } ],
       "returns" : {
         "type" : "primitive",
         "primitive" : "BINARY"
       },
-      "docs" : "Generates an HLS playlist for a video with the given video rid to enable playback. The HLS playlist will contain\nlinks to all of the segments in the video in sequential order.\n",
-      "deprecated" : "Replaced by getPlaylistInBounds. Will be removed after April 15th.",
+      "docs" : "Generates an HLS playlist for a video within optional time bounds.\nUses GET with query parameters for HLS.js compatibility.\nThe HLS playlist will contain links to all of the segments in the video that overlap with the given bounds,\nor all segments if no bounds are provided.\n\nNote: The start and end parameters must either both be provided or both be omitted.\nProviding only one will result in a MissingTimestampBoundPair error.\n",
       "markers" : [ ],
       "tags" : [ ]
     }, {
@@ -93143,6 +93683,7 @@
         "primitive" : "BINARY"
       },
       "docs" : "Generates an HLS playlist for a video with the given video rid to enable playback within an optional set of\nbounds. The HLS playlist will contain links to all of the segments in the video that overlap with the given \nbounds.\nplaylist will be limited to the given bounds.\n",
+      "deprecated" : "Use getPlaylist (GET) for HLS.js compatibility.",
       "markers" : [ ],
       "tags" : [ ]
     }, {
@@ -93174,6 +93715,154 @@
         "primitive" : "BINARY"
       },
       "docs" : "Generates an HLS playlist for a video channel series (identified by channel + tags) within an optional set of\nbounds then generates a playlist for all matching video segments.\n",
+      "deprecated" : "Use getPlaylistForChannel (GET) for HLS.js compatibility.",
+      "markers" : [ ],
+      "tags" : [ ]
+    }, {
+      "endpointName" : "getPlaylistForChannel",
+      "httpMethod" : "GET",
+      "httpPath" : "/video/v1/videos/channel/playlist",
+      "auth" : {
+        "type" : "header",
+        "header" : { }
+      },
+      "args" : [ {
+        "argName" : "dataSourceRid",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "reference",
+              "reference" : {
+                "name" : "DataSourceRid",
+                "package" : "io.nominal.api.rids"
+              }
+            }
+          }
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "dataSourceRid"
+          }
+        },
+        "docs" : "Data source RID (mutually exclusive with assetRid)",
+        "markers" : [ ],
+        "tags" : [ ]
+      }, {
+        "argName" : "assetRid",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "reference",
+              "reference" : {
+                "name" : "AssetRid",
+                "package" : "io.nominal.scout.rids.api"
+              }
+            }
+          }
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "assetRid"
+          }
+        },
+        "docs" : "Asset RID (mutually exclusive with dataSourceRid, requires dataScopeName)",
+        "markers" : [ ],
+        "tags" : [ ]
+      }, {
+        "argName" : "dataScopeName",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "primitive",
+              "primitive" : "STRING"
+            }
+          }
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "dataScopeName"
+          }
+        },
+        "docs" : "Data scope name (required when using assetRid)",
+        "markers" : [ ],
+        "tags" : [ ]
+      }, {
+        "argName" : "channel",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "channel"
+          }
+        },
+        "docs" : "Channel name",
+        "markers" : [ ],
+        "tags" : [ ]
+      }, {
+        "argName" : "tags",
+        "type" : {
+          "type" : "optional",
+          "optional" : {
+            "itemType" : {
+              "type" : "primitive",
+              "primitive" : "STRING"
+            }
+          }
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "tags"
+          }
+        },
+        "docs" : "Tags as JSON-encoded map (e.g., {\"vehicle\":\"car1\"})",
+        "markers" : [ ],
+        "tags" : [ ]
+      }, {
+        "argName" : "start",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "start"
+          }
+        },
+        "docs" : "Required start bound as ISO-8601 timestamp (e.g., \"2024-01-01T00:00:00Z\"). Must be provided with end.",
+        "markers" : [ ],
+        "tags" : [ ]
+      }, {
+        "argName" : "end",
+        "type" : {
+          "type" : "primitive",
+          "primitive" : "STRING"
+        },
+        "paramType" : {
+          "type" : "query",
+          "query" : {
+            "paramId" : "end"
+          }
+        },
+        "docs" : "Required end bound as ISO-8601 timestamp (e.g., \"2024-01-01T01:00:00Z\"). Must be provided with start.",
+        "markers" : [ ],
+        "tags" : [ ]
+      } ],
+      "returns" : {
+        "type" : "primitive",
+        "primitive" : "BINARY"
+      },
+      "docs" : "Generates an HLS playlist for a video channel series within time bounds.\nSpecify either dataSourceRid OR (assetRid + dataScopeName) to identify the channel source.\n\nNote: Both start and end parameters are required and must be provided together.\n",
       "markers" : [ ],
       "tags" : [ ]
     }, {