@uug-ai/models 1.6.10 → 1.6.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/types.d.ts +228 -2
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -20049,6 +20049,162 @@ export interface paths {
20049
20049
  patch?: never;
20050
20050
  trace?: never;
20051
20051
  };
20052
+ "/internal/runworkflowerrorresponse": {
20053
+ parameters: {
20054
+ query?: never;
20055
+ header?: never;
20056
+ path?: never;
20057
+ cookie?: never;
20058
+ };
20059
+ /**
20060
+ * Get RunWorkflowErrorResponse (schema generation only)
20061
+ * @description Internal endpoint used only to ensure RunWorkflowErrorResponse schema is generated in OpenAPI spec
20062
+ */
20063
+ get: {
20064
+ parameters: {
20065
+ query?: never;
20066
+ header?: never;
20067
+ path?: never;
20068
+ cookie?: never;
20069
+ };
20070
+ requestBody?: never;
20071
+ responses: {
20072
+ /** @description OK */
20073
+ 200: {
20074
+ headers: {
20075
+ [name: string]: unknown;
20076
+ };
20077
+ content: {
20078
+ "application/json": components["schemas"]["api.RunWorkflowErrorResponse"];
20079
+ };
20080
+ };
20081
+ };
20082
+ };
20083
+ put?: never;
20084
+ post?: never;
20085
+ delete?: never;
20086
+ options?: never;
20087
+ head?: never;
20088
+ patch?: never;
20089
+ trace?: never;
20090
+ };
20091
+ "/internal/runworkflowrequest": {
20092
+ parameters: {
20093
+ query?: never;
20094
+ header?: never;
20095
+ path?: never;
20096
+ cookie?: never;
20097
+ };
20098
+ /**
20099
+ * Get RunWorkflowRequest (schema generation only)
20100
+ * @description Internal endpoint used only to ensure RunWorkflowRequest schema is generated in OpenAPI spec
20101
+ */
20102
+ get: {
20103
+ parameters: {
20104
+ query?: never;
20105
+ header?: never;
20106
+ path?: never;
20107
+ cookie?: never;
20108
+ };
20109
+ requestBody?: never;
20110
+ responses: {
20111
+ /** @description OK */
20112
+ 200: {
20113
+ headers: {
20114
+ [name: string]: unknown;
20115
+ };
20116
+ content: {
20117
+ "application/json": components["schemas"]["api.RunWorkflowRequest"];
20118
+ };
20119
+ };
20120
+ };
20121
+ };
20122
+ put?: never;
20123
+ post?: never;
20124
+ delete?: never;
20125
+ options?: never;
20126
+ head?: never;
20127
+ patch?: never;
20128
+ trace?: never;
20129
+ };
20130
+ "/internal/runworkflowresponse": {
20131
+ parameters: {
20132
+ query?: never;
20133
+ header?: never;
20134
+ path?: never;
20135
+ cookie?: never;
20136
+ };
20137
+ /**
20138
+ * Get RunWorkflowResponse (schema generation only)
20139
+ * @description Internal endpoint used only to ensure RunWorkflowResponse schema is generated in OpenAPI spec
20140
+ */
20141
+ get: {
20142
+ parameters: {
20143
+ query?: never;
20144
+ header?: never;
20145
+ path?: never;
20146
+ cookie?: never;
20147
+ };
20148
+ requestBody?: never;
20149
+ responses: {
20150
+ /** @description OK */
20151
+ 200: {
20152
+ headers: {
20153
+ [name: string]: unknown;
20154
+ };
20155
+ content: {
20156
+ "application/json": components["schemas"]["api.RunWorkflowResponse"];
20157
+ };
20158
+ };
20159
+ };
20160
+ };
20161
+ put?: never;
20162
+ post?: never;
20163
+ delete?: never;
20164
+ options?: never;
20165
+ head?: never;
20166
+ patch?: never;
20167
+ trace?: never;
20168
+ };
20169
+ "/internal/runworkflowsuccessresponse": {
20170
+ parameters: {
20171
+ query?: never;
20172
+ header?: never;
20173
+ path?: never;
20174
+ cookie?: never;
20175
+ };
20176
+ /**
20177
+ * Get RunWorkflowSuccessResponse (schema generation only)
20178
+ * @description Internal endpoint used only to ensure RunWorkflowSuccessResponse schema is generated in OpenAPI spec
20179
+ */
20180
+ get: {
20181
+ parameters: {
20182
+ query?: never;
20183
+ header?: never;
20184
+ path?: never;
20185
+ cookie?: never;
20186
+ };
20187
+ requestBody?: never;
20188
+ responses: {
20189
+ /** @description OK */
20190
+ 200: {
20191
+ headers: {
20192
+ [name: string]: unknown;
20193
+ };
20194
+ content: {
20195
+ "application/json": components["schemas"]["api.RunWorkflowSuccessResponse"];
20196
+ };
20197
+ };
20198
+ };
20199
+ };
20200
+ put?: never;
20201
+ post?: never;
20202
+ delete?: never;
20203
+ options?: never;
20204
+ head?: never;
20205
+ patch?: never;
20206
+ trace?: never;
20207
+ };
20052
20208
  "/internal/savefaceredactionerrorresponse": {
20053
20209
  parameters: {
20054
20210
  query?: never;
@@ -28876,6 +29032,39 @@ export interface components {
28876
29032
  /** @description Additional metadata about the response, such as timestamps and request IDs */
28877
29033
  metadata?: components["schemas"]["api.Metadata"];
28878
29034
  };
29035
+ "api.RunWorkflowErrorResponse": {
29036
+ /** @description Application-specific error code */
29037
+ applicationStatusCode?: string;
29038
+ /** @description Entity-specific error code */
29039
+ entityStatusCode?: string;
29040
+ /** @description HTTP status code for the error */
29041
+ httpStatusCode?: number;
29042
+ /** @description Error message describing the issue */
29043
+ message?: string;
29044
+ /** @description Additional metadata about the error, such as timestamps and request IDs */
29045
+ metadata?: components["schemas"]["api.Metadata"];
29046
+ };
29047
+ "api.RunWorkflowRequest": {
29048
+ mediaIds?: string[];
29049
+ workflowId?: string;
29050
+ };
29051
+ "api.RunWorkflowResponse": {
29052
+ count?: number;
29053
+ runIds?: string[];
29054
+ };
29055
+ "api.RunWorkflowSuccessResponse": {
29056
+ /** @description Application-specific status code */
29057
+ applicationStatusCode?: string;
29058
+ data?: components["schemas"]["api.RunWorkflowResponse"];
29059
+ /** @description Entity-specific status code */
29060
+ entityStatusCode?: string;
29061
+ /** @description HTTP status code for the response */
29062
+ httpStatusCode?: number;
29063
+ /** @description Success message describing the operation */
29064
+ message?: string;
29065
+ /** @description Additional metadata about the response, such as timestamps and request IDs */
29066
+ metadata?: components["schemas"]["api.Metadata"];
29067
+ };
28879
29068
  "api.SaveFaceRedactionErrorResponse": {
28880
29069
  /** @description Application-specific error code */
28881
29070
  applicationStatusCode?: string;
@@ -30237,7 +30426,7 @@ export interface components {
30237
30426
  website?: string;
30238
30427
  };
30239
30428
  /** @enum {string} */
30240
- "models.ConditionOp": "eq" | "ne" | "contains" | "in" | "exists" | "gt" | "gte" | "lt" | "lte";
30429
+ "models.ConditionOp": "eq" | "ne" | "contains" | "in" | "exists" | "matches" | "gt" | "gte" | "lt" | "lte";
30241
30430
  "models.Contact": {
30242
30431
  email?: string;
30243
30432
  name?: string;
@@ -32838,6 +33027,8 @@ export interface components {
32838
33027
  deviceName?: string;
32839
33028
  /** @description media VideoProvider: where the media is served from */
32840
33029
  provider?: string;
33030
+ /** @description site ids the device is linked to (Device.SiteIds); a gate value, matchable with contains/in/exists/matches */
33031
+ siteIds?: string[];
32841
33032
  /** @description media StorageSolution: where the media is stored */
32842
33033
  storageSolution?: string;
32843
33034
  };
@@ -33020,6 +33211,20 @@ export interface components {
33020
33211
  * (a case id today; a temporal device-series id is a forward-looking twin).
33021
33212
  */
33022
33213
  sourceRef?: string;
33214
+ /**
33215
+ * @description Stages is the run's self-describing routing: the compiled stage set of the
33216
+ * workflow this run executes (the output of Workflow.CompileStages) embedded
33217
+ * on the hand-off so the engine can dispatch a workflow it does not hold in
33218
+ * its boot-loaded config registry — a user/DB workflow launched manually.
33219
+ * Only routing fields are meaningful here (Operation, Dispatch, Needs,
33220
+ * NeedsMode; Queue when the source workflow set one); the engine compiles
33221
+ * these into the same validated registry a config workflow gets. Empty is the
33222
+ * legacy/config path: the engine falls back to the config registry keyed by
33223
+ * WorkflowId, so config workflows and older hand-offs are unchanged. It is
33224
+ * persisted so the return path — a stage result reopening the run on any
33225
+ * replica — resolves the same routing without re-fetching the definition.
33226
+ */
33227
+ stages?: components["schemas"]["models.WorkflowStage"][];
33023
33228
  /**
33024
33229
  * @description Storage carries the credentials a dispatched stage worker needs to fetch
33025
33230
  * the media (global Kerberos Storage plus any resolved per-recording vault
@@ -33161,10 +33366,26 @@ export interface components {
33161
33366
  vaultOverrideUri?: string;
33162
33367
  };
33163
33368
  "models.WorkflowTrigger": {
33369
+ /**
33370
+ * @description Conditions further scopes the automatic trigger with the same structured
33371
+ * (path, op, value) predicates a stage uses, evaluated against the pre-run
33372
+ * envelope (device.*, user.*, and the identity scalars known when a recording
33373
+ * arrives). All conditions must hold (AND) and they combine with the compiled
33374
+ * Devices shorthand, so `matches`, `in`, `eq`, … apply to device matching the
33375
+ * way they do to stages. An empty list adds no constraint. See
33376
+ * CompiledConditions and StageCondition.
33377
+ */
33378
+ conditions?: components["schemas"]["models.StageCondition"][];
33164
33379
  /**
33165
33380
  * @description Devices restricts the automatic trigger to recordings from the listed
33166
33381
  * devices, matched by DeviceKey.Key. An empty list means every device is
33167
33382
  * eligible. Mirrors the alert device selection (see CustomAlert.DevicesList).
33383
+ *
33384
+ * It is a convenience shorthand: a non-empty list compiles (see
33385
+ * CompiledConditions) into a single StageCondition — device.deviceKey `in`
33386
+ * [keys…] — evaluated by the same operator engine stage conditions use, so
33387
+ * device scoping and stage matching stay consistent. Author richer scoping
33388
+ * (a device-name pattern, an organisation check, …) with Conditions.
33168
33389
  */
33169
33390
  devices?: components["schemas"]["models.DeviceKey"][];
33170
33391
  /**
@@ -33183,7 +33404,8 @@ export interface components {
33183
33404
  * each with its own day, time segments and IANA Timezone. An empty schedule
33184
33405
  * means any time is eligible. Reuses the alert weekly-schedule shape so the
33185
33406
  * same editor and evaluation semantics apply. The Timezone on each entry is
33186
- * the user's timezone captured when the schedule was authored.
33407
+ * the user's timezone captured when the schedule was authored. Time is not
33408
+ * path-expressible, so it stays a dedicated field rather than a condition.
33187
33409
  */
33188
33410
  weeklySchedule?: components["schemas"]["models.WeeklySchedule"][];
33189
33411
  };
@@ -33767,6 +33989,10 @@ export declare namespace api {
33767
33989
  type RequestTaskExportErrorResponse = components['schemas']['api.RequestTaskExportErrorResponse'];
33768
33990
  type RequestTaskExportResponse = components['schemas']['api.RequestTaskExportResponse'];
33769
33991
  type RequestTaskExportSuccessResponse = components['schemas']['api.RequestTaskExportSuccessResponse'];
33992
+ type RunWorkflowErrorResponse = components['schemas']['api.RunWorkflowErrorResponse'];
33993
+ type RunWorkflowRequest = components['schemas']['api.RunWorkflowRequest'];
33994
+ type RunWorkflowResponse = components['schemas']['api.RunWorkflowResponse'];
33995
+ type RunWorkflowSuccessResponse = components['schemas']['api.RunWorkflowSuccessResponse'];
33770
33996
  type SaveFaceRedactionErrorResponse = components['schemas']['api.SaveFaceRedactionErrorResponse'];
33771
33997
  type SaveFaceRedactionRequest = components['schemas']['api.SaveFaceRedactionRequest'];
33772
33998
  type SaveFaceRedactionResponse = components['schemas']['api.SaveFaceRedactionResponse'];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uug-ai/models",
3
- "version": "1.6.10",
3
+ "version": "1.6.11",
4
4
  "description": "TypeScript type definitions for Go models",
5
5
  "main": "dist/types.js",
6
6
  "types": "dist/types.d.ts",