Skip to content

Chore/submit flags flagtypes #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
masonville17 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Chore/submit flags flagtypes #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76e8348
I believe that was everything related to flags and flag types
masonville17 Jan 8, 2026
f1aaacf
added these to psd1 and included the two helpers for correlating huma…
masonville17 Jan 8, 2026
175f115
Update Get-HuduFlags.ps1
masonville17 Jan 20, 2026
c57a985
Update Get-HuduFlagTypes.ps1 - ensure that page and page_size propert…
masonville17 Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 142 additions & 0 deletions Docs/Get-HuduFlagTypes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
---
external help file: HuduAPI-help.xml
Module Name: HuduAPI
online version:
schema: 2.0.0
---

# Get-HuduFlagTypes

## SYNOPSIS
Gets Flag Types from Hudu.

## SYNTAX

### List (Default)
```
Get-HuduFlagTypes [-Name <String>] [-Color <String>] [-Slug <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

### ById
```
Get-HuduFlagTypes [-Id <Int32>] [-Color <String>] [-Slug <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Retrieves Flag Types by ID or lists Flag Types with optional filtering.
When listing,
filters match exact values for name/color/slug when provided.
Results are paginated.

## EXAMPLES

### EXAMPLE 1
```
Get-HuduFlagTypes
# List all flag types
```

### EXAMPLE 2
```
Get-HuduFlagTypes -Name "Security Risk"
# Find the "Security Risk" flag type
```

### EXAMPLE 3
```
Get-HuduFlagTypes -Id 12
# Get a specific flag type by ID
```

## PARAMETERS

### -Id
Return a single Flag Type by ID.

```yaml
Type: Int32
Parameter Sets: ById
Aliases: FlagTypeId, flag_type_id

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Name
Filter by exact Flag Type name.

```yaml
Type: String
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Color
Filter by exact color value (canonicalized to Hudu).

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Slug
Filter by exact slug value.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
API Endpoints:
- GET /api/v1/flag_types
- GET /api/v1/flag_types/{id}

## RELATED LINKS
162 changes: 162 additions & 0 deletions Docs/Get-HuduFlags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
---
external help file: HuduAPI-help.xml
Module Name: HuduAPI
online version:
schema: 2.0.0
---

# Get-HuduFlags

## SYNOPSIS
Gets Flags from Hudu.

## SYNTAX

### List (Default)
```
Get-HuduFlags [-FlagTypeId <Int32>] [-flagable_type <String>] [-flagable_id <Int32>] [-Description <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### ById
```
Get-HuduFlags [-Id <Int32>] [-Description <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Retrieves a single Flag by ID, or lists Flags with optional filtering by flag type,
target object type/id, and description.
Results are paginated when listing.

## EXAMPLES

### EXAMPLE 1
```
Get-HuduFlags
# List all flags (paginated)
```

### EXAMPLE 2
```
Get-HuduFlags -FlagTypeId 5
# List all flags using flag type 5
```

### EXAMPLE 3
```
Get-HuduFlags -flagable_type Company -flagable_id 123
# List all flags attached to company 123
```

### EXAMPLE 4
```
Get-HuduFlags -Id 77
# Get a single flag by ID
```

## PARAMETERS

### -Id
Return a single Flag by ID.

```yaml
Type: Int32
Parameter Sets: ById
Aliases: FlagId, flag_id

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -FlagTypeId
Filter flags by Flag Type ID.

```yaml
Type: Int32
Parameter Sets: List
Aliases: Flag_Type_ID, FlagType_ID, Flag_TypeId

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -flagable_type
Filter by the target object type the flag is attached to (e.g., Company, Asset).
This value is normalized to Hudu's canonical flagable_type.

```yaml
Type: String
Parameter Sets: List
Aliases: flagabletype, flaggable_type, flaggabletype, Flag_type, FlagType

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -flagable_id
Filter by the target object ID the flag is attached to.

```yaml
Type: Int32
Parameter Sets: List
Aliases: FlaggableId, flaggable_id, flagableid

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Description
Filter by description text (exact match behavior depends on API; treat as an exact filter unless documented otherwise).

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
API Endpoints:
- GET /api/v1/flags
- GET /api/v1/flags/{id}

## RELATED LINKS
Loading