Adds Helix event cmdlets and epoch time parameter

docs/function-documentation/Add-VerkadaHelixEvent.md

@@ -14,8 +14,9 @@ Creates a Helix event in Commadn using https://apidocs.verkada.com/reference/pos
 
 ```
 Add-VerkadaHelixEvent [[-org_id] <String>] [-camera_id] <String> [-event_type_uid] <String>
- [-timeStamp] <DateTime> [-attributes] <Object> [[-flagged] <Boolean>] [[-x_verkada_auth_api] <String>]
- [[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+ [[-timeStamp] <DateTime>] [[-epoch_time] <Int64>] [-attributes] <Object> [[-flagged] <Boolean>]
+ [[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -86,20 +87,35 @@ Accept wildcard characters: False
 ```
 
 ### -timeStamp
-The the epoch time of the event
+The the timestamp of the event
 
 ```yaml
 Type: DateTime
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: 4
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -epoch_time
+The the epoch time of the event in milliseconds
+
+```yaml
+Type: Int64
+Parameter Sets: (All)
+Aliases: time_ms
+
+Required: False
+Position: 5
+Default value: 0
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -attributes
 The parameters to be submitted for the event
 
@@ -109,7 +125,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: 5
+Position: 6
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
@@ -124,7 +140,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 6
+Position: 7
 Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -139,7 +155,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 7
+Position: 8
 Default value: $Global:verkadaConnection.x_verkada_auth_api
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -154,7 +170,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 8
+Position: 9
 Default value: Api
 Accept pipeline input: False
 Accept wildcard characters: False

docs/function-documentation/Find-VerkadaHelixEvent.md

@@ -0,0 +1,275 @@
+---
+external help file: verkadaModule-help.xml
+Module Name: verkadaModule
+online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Find-VerkadaHelixEvent.md
+schema: 2.0.0
+---
+
+# Find-VerkadaHelixEvent
+
+## SYNOPSIS
+Finds Helix event using https://apidocs.verkada.com/reference/postvideotaggingeventsearchviewv1
+
+## SYNTAX
+
+```
+Find-VerkadaHelixEvent [[-org_id] <String>] [[-camera_ids] <String[]>] [[-event_type_uid] <String>]
+ [[-startTimeStamp] <DateTime>] [[-start_epoch_time] <Int64>] [[-endTimeStamp] <DateTime>]
+ [[-end_epoch_time] <Int64>] [[-attribute_filters] <Object[]>] [[-keywords] <String[]>] [[-flagged] <Boolean>]
+ [[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+This method can be used to search for either a single or multiple Helix Events that have already been posted to Command.
+In the return message, the users will be able to see the corresponding attribute keys and attribute values for those specific Helix Events.
+
+The only required parameters to search for Helix Events is a Verkada API Token with Helix permissions.
+Users will be returned a complete list of all Helix Events that are currently available in Command.
+Users can further narrow down their search by adding:
+
+Camera ID: returns all Helix Events linked to that specific camera or list of cameras.
+Event Type UID: returns all Helix Events that share that specific Event Type UID.
+Start and End Times: returns all Helix Events that have occurred during that time range.
+Attributes Keys and Values: returns all Helix Events that have attributes keys and values matching the user's entered parameters.
+The org_id and reqired token can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Find-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc
+This will get the helix events for camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc. The org_id and token will be populated from the cached created by Connect-Verkada.
+```
+
+### EXAMPLE 2
+```
+Find-VerkadaHelixEvent -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -startTimeStamp '1/1/2025 08:35:00 -06' -endTimeStamp '1/7/2025 17:00:00 -06' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
+This will find the helix events for from Jan 1, 2025 at 8:35 AM CST to Jan 7, 2025 at 5:00 APM CST for the sepcified event ID. The org_id and token are submitted as parameters in the call.
+```
+
+## PARAMETERS
+
+### -org_id
+The UUID of the organization the user belongs to
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+Default value: $Global:verkadaConnection.org_id
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -camera_ids
+The UUID of the camera who's name is being changed
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases: cameraId, cameraIds, camera_id
+
+Required: False
+Position: 2
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -event_type_uid
+The UID of the event type to be used when creating the event
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 3
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -startTimeStamp
+The the start timestamp of the events being serached
+
+```yaml
+Type: DateTime
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 4
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -start_epoch_time
+The the epoch start time of the events being serached in milliseconds
+
+```yaml
+Type: Int64
+Parameter Sets: (All)
+Aliases: start_time_ms
+
+Required: False
+Position: 5
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -endTimeStamp
+The the end timestamp of the events being serached
+
+```yaml
+Type: DateTime
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 6
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -end_epoch_time
+The the epoch end time of the events being serached in milliseconds
+
+```yaml
+Type: Int64
+Parameter Sets: (All)
+Aliases: end_time_ms
+
+Required: False
+Position: 7
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -attribute_filters
+The attribute filters to be used in the search query
+
+```yaml
+Type: Object[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 8
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -keywords
+The keyword/s to be used in the search query
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases: keyword
+
+Required: False
+Position: 9
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -flagged
+Boolean if the event should be flagged
+
+```yaml
+Type: Boolean
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 10
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -x_verkada_auth_api
+The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 11
+Default value: $Global:verkadaConnection.x_verkada_auth_api
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -region
+The region of the public API to be used
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 12
+Default value: Api
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -errorsToFile
+Switch to write errors to file
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Find-VerkadaHelixEvent.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Find-VerkadaHelixEvent.md)
+